Skip to content

Commit 6495d1b

Browse files
authored
docs: generate llms.txt (#1513)
* docs: generate llms.txt * chore: typo fix
1 parent 7adabb5 commit 6495d1b

File tree

3 files changed

+767
-5
lines changed

3 files changed

+767
-5
lines changed

docs/.vitepress/shared.mts

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import { createRequire } from 'module';
22
import path from 'path';
33
import { defineConfig } from 'vitepress';
4+
import llmstxt from 'vitepress-plugin-llms';
45
import { search as koSearch } from './ko.mts';
56
import { search as zh_hansSearch } from './zh_hans.mts';
67

@@ -143,5 +144,17 @@ export const shared = defineConfig({
143144
),
144145
},
145146
},
147+
plugins: [
148+
llmstxt({
149+
ignoreFiles: ['public/**/*', 'ja/**/*', 'ko/**/*', 'zh_hans/**/*', 'index.md', 'team.md'],
150+
description: 'State-of-the-art JavaScript utility library',
151+
details: `\
152+
es-toolkit is a modern JavaScript utility library that offers a collection of powerful functions for everyday use.
153+
154+
Compared to alternatives like lodash, es-toolkit provides a significantly smaller bundle size (up to 97% less) and 2-3 times faster runtime performance. This is achieved through a modern implementation that leverages the latest JavaScript features.
155+
156+
es-toolkit comes with built-in TypeScript types and has been rigorously tested, ensuring 100% test coverage for maximum reliability.`,
157+
}),
158+
],
146159
},
147160
});

docs/package.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
"fast-glob": "^3.3.2",
1111
"markdown-it-container": "^4.0.0",
1212
"vitepress": "^1.3.2",
13+
"vitepress-plugin-llms": "^1.9.0",
1314
"vitepress-plugin-sandpack": "^1.1.4",
1415
"vue": "^3.4.37"
1516
}

0 commit comments

Comments
 (0)