Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
🚀 Deploying Preview to Cloudflare 🚀Preview Deployments by commit
|
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## feat/graphviz-diagrams #1127 +/- ##
==========================================================
- Coverage 92.94% 92.86% -0.08%
==========================================================
Files 262 264 +2
Lines 25341 25435 +94
Branches 2589 2600 +11
==========================================================
+ Hits 23553 23621 +68
- Misses 1766 1792 +26
Partials 22 22 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
|
| File | Main | PR | Change |
|---|---|---|---|
assets/style-Dpi-h_PZ.css |
— | 137.38 KB | +137.38 KB |
assets/style-CgRaeUUe.css |
137.19 KB | — | -137.19 KB (-100.0%) |
Performance estimate (single CI run)
- Generation time: 12.8% faster (51.81 s → 45.16 s)
- Peak memory: 23.2% higher (3.25 GB → 4.00 GB)
82490d7 to
0f386b2
Compare
| defaultConfiguration: { | ||
| templatePath: join(import.meta.dirname, 'template.txt'), | ||
| pageURL: '{baseURL}{path}.md', | ||
| writeMarkdown: false, |
There was a problem hiding this comment.
Does this need to be in the generator, or can it just be cp input output, this feels out of scope.
| - `templatePath` {string} Path to the template file. | ||
| **Default:** `'template.txt'`. | ||
| - `pageURL` {string} URL template for documentation page links. | ||
| **Default:** `'{baseURL}/latest/api{path}.md'`. |
There was a problem hiding this comment.
Make sure to update the Node.js config since this default changed
| if (config.writeFull) { | ||
| const full = pages.map( | ||
| ({ path, markdown }) => | ||
| `---\nurl: ${populate(config.pageURL, { ...config, path })}\n---\n${markdown}` | ||
| ); | ||
|
|
||
| await writeFile(join(config.output, 'llms-full.txt'), full.join('\n')); |
There was a problem hiding this comment.
llms-full-txt as a separate generator might be smarter, since these don't actually share any data, wdyt?
0f386b2 to
bbfc21c
Compare
bbfc21c to
9566b83
Compare
9566b83 to
762bf78
Compare
Two options: `writeMarkdown` writes the Markdown of every page at the `.md` URLs llms.txt links by default, and `writeFull` writes llms-full.txt, holding every page preceded by its URL. Assisted-by: Claude Opus 5.5 <noreply@anthropic.com>
Assisted-by: Claude Opus 5.5 <noreply@anthropic.com>
Assisted-by: Claude Opus 5.5 <noreply@anthropic.com>
762bf78 to
64217c9
Compare
Description
This PR adds two opt-in options to the
llms-txtgenerator:writeMarkdown: writes the Markdown of every page at{path}.md, which is wherellms.txtlinks by default (pageURL: '{baseURL}{path}.md'), so those links resolve without a separate copy step.writeFull: writesllms-full.txtwith every page, each preceded by its URL. It's the same format VitePress' llms plugin produces.Pages are rebuilt from the metadata entries' content with doc-kit's own remark stringify (the MDX one for MDX pages), skipping synthetic pages.
This is part of a proof of concept of migrating rolldown.rs from VitePress to doc-kit. rolldown.rs serves both today, and this keeps parity without a post-build script.
Validation
llms-full.txtand a.mdfile per page.Related Issues
Part of the Rolldown docs migration PoC: rolldown/rolldown#11072. It's the top of a stack: #1125 (TypeDoc plugin) → #1126 (Graphviz diagrams) → #1127 (llms-full), each targeting the one below. The changes don't depend on each other, the stack just keeps them reviewable one at a time while the Rolldown PoC builds from the top branch.
Check List
node --run testand all tests passed.node --run format:check&node --run lint.