Doc kit docs#889
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #889 +/- ##
==========================================
- Coverage 85.04% 83.80% -1.24%
==========================================
Files 179 183 +4
Lines 16496 16841 +345
Branches 1500 1512 +12
==========================================
+ Hits 14029 14114 +85
- Misses 2457 2717 +260
Partials 10 10 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
| File | Base | Head | Diff |
|---|---|---|---|
all.html |
19.94 MB | 19.94 MB | -234.00 B (-0.00%) |
AugustinMauroy
left a comment
AugustinMauroy
left a comment
There was a problem hiding this comment.
Noice !
also we should add a "why doc-kit" section but with a "TBD" and in future have comparison with fuma-docs/docausorus ...
|
|
||
| ## It is a pipeline, not a Markdown converter | ||
|
|
||
| doc-kit is not a general-purpose Markdown-to-HTML tool. Input is parsed once |
There was a problem hiding this comment.
we should define how to "spell" doc-kit should it be simple text or doc-kit ?
| `@node-core/doc-kit` is the documentation toolchain behind the Node.js API | ||
| reference. It reads API-shaped Markdown and emits HTML, JSON, man pages, | ||
| search indexes, and `llms.txt`. |
There was a problem hiding this comment.
| `@node-core/doc-kit` is the documentation toolchain behind the Node.js API | |
| reference. It reads API-shaped Markdown and emits HTML, JSON, man pages, | |
| search indexes, and `llms.txt`. | |
| `@node-core/doc-kit` is the documentation toolchain originally design for | |
| the Node.js API reference. It reads API-shaped Markdown and emits HTML, | |
| JSON, man pages, search indexes, and `llms.txt`. |
| > page's identity — its sidebar label and its output filename. A file without | ||
| > one produces no page at all, and the build still exits `0`. | ||
|
|
||
| See [the specification](./specification.html) for the full input format. |
There was a problem hiding this comment.
if I recall correctly on this file we can customize the color theme.
And IMO we should change it. Why not keep green ? this green will be understood as nodejs runtime related. so for undici, learn it's work well. But if we want to as general propose tool we should chose another colors.
Also it's good example of how can this be customized.
| run: npm ci | ||
|
|
||
| - name: Build site | ||
| run: npm run docs:build |
There was a problem hiding this comment.
| run: npm run docs:build | |
| run: node --run docs:build |
there are 0 reasons to use npm
| - name: Upload site artifact | ||
| uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1 | ||
| with: | ||
| name: docs-site | ||
| path: www/out |
There was a problem hiding this comment.
what if we deploy the docs on GH page ?
There was a problem hiding this comment.
i dont have strong opinions here other that continuing our current patterns.
2 participants
Description
Introduces the doc-kit documentation site, built with doc-kit!
This also serves as a reasonable simple
webexample.Validation
Related Issues
Check List
node --run testand all tests passed.node --run format&node --run lint.