Skip to content

feat(build): generate llms.txt via doc-kit #201

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bjohansebas merged 2 commits into from
Jul 22, 2026
+39 −1
Merged

feat(build): generate llms.txt via doc-kit #201

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2c1daf3
feat(build): generate llms.txt via doc-kit
bjohansebas Jul 21, 2026
0736b2f
Apply suggestion from @bjohansebas
bjohansebas Jul 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions scripts/html/doc-kit.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,11 @@ export default {
generateIndexPage: false,
generateAllPage: false,
},
'llms-txt': {
templatePath: join(ROOT, 'scripts/html/llms-template.txt'),
pageURL: `${BASE_URL.replace(/\/$/, '')}{path}.md`,
output: VERSION ? `./out/docs/api/${MAJOR_VERSION}` : './out',
},
web: {
project: 'webpack',
useAbsoluteURLs: true,
Expand Down
27 changes: 26 additions & 1 deletion scripts/html/index.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,23 @@
import { execFile } from 'node:child_process';
import { readFile } from 'node:fs/promises';
import { cp, readFile, writeFile } from 'node:fs/promises';
import { statSync } from 'node:fs';
import { promisify } from 'node:util';

const execFileAsync = promisify(execFile);

// TODO: Have doc-kit understand that some pages don't have meaningful information
// The llms-txt generator lists every page with a depth-1 heading. JSX-driven
// pages like the homepage produce entries with no title or description — drop
// them, they carry no information for LLMs.
const cleanLlmsTxt = async path => {
const content = await readFile(path, 'utf8');
const cleaned = content
.split('\n')
.filter(line => !line.startsWith('- []('))
.join('\n');
await writeFile(path, cleaned);
};

Comment thread
bjohansebas marked this conversation as resolved.
const runDocKit = version =>
execFileAsync(
'npx',
Expand All @@ -16,6 +30,8 @@ const runDocKit = version =>
'web',
'-t',
'orama-db',
'-t',
'llms-txt',
'--config-file',
'./scripts/html/doc-kit.config.mjs',
],
Expand All @@ -35,5 +51,14 @@ const versions = JSON.parse(await readFile('./versions.json'));

for (const version of versions) {
await runDocKit(version);
await cleanLlmsTxt(`./out/docs/api/v${version.match(/\d+/)[0]}.x/llms.txt`);
}
await runDocKit();
await cleanLlmsTxt('./out/llms.txt');

// Publish the markdown sources next to the rendered pages so the llms.txt
// links (`{path}.md`) resolve to LLM-friendly raw markdown.
await cp('./pages', './out', {
recursive: true,
filter: source => statSync(source).isDirectory() || source.endsWith('.md'),
});
8 changes: 8 additions & 0 deletions scripts/html/llms-template.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# webpack Documentation

> webpack is a static module bundler for modern JavaScript applications. It builds a dependency graph from one or more entry points and combines every module your project needs into one or more bundles, and it can transform, bundle, or package just about any resource or asset.

Below are the sections of the webpack documentation. Look out especially towards the links that point towards guidance/introduction to the structure of this documentation.

## Documentation

Loading