Skip to content

Commit 59a7a00

Browse files
authored
docs: add documentation for LLMs (llms.txt) (#189)
Thanks to https://github.com/okineadev/vitepress-plugin-llms
1 parent c91259a commit 59a7a00

File tree

4 files changed

+374
-2
lines changed

4 files changed

+374
-2
lines changed

docs/.vitepress/config.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import type { DefaultTheme } from 'vitepress'
22
import UnoCSS from 'unocss/vite'
3+
import llmstxt, { copyOrDownloadAsMarkdownButtons } from 'vitepress-plugin-llms'
34
import { defineConfig } from 'vitepress'
45
import { description, github, name, ogImage, ogUrl, releases, twitterImage, version } from './meta'
56

@@ -24,7 +25,7 @@ export default defineConfig({
2425

2526
vite: {
2627
// @ts-expect-error – UnoCSS types are not compatible with Vite yet
27-
plugins: [UnoCSS()],
28+
plugins: [UnoCSS(), llmstxt()],
2829
},
2930

3031
themeConfig: {
@@ -93,6 +94,11 @@ export default defineConfig({
9394
provider: 'local',
9495
},
9596
},
97+
markdown: {
98+
config(md) {
99+
md.use(copyOrDownloadAsMarkdownButtons)
100+
}
101+
}
96102
})
97103

98104
function sidebarPrimary(): DefaultTheme.SidebarItem[] {

docs/.vitepress/theme/index.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import type { Theme } from 'vitepress'
22
import DefaultTheme from 'vitepress/theme'
3+
import CopyOrDownloadAsMarkdownButtons from 'vitepress-plugin-llms/vitepress-components/CopyOrDownloadAsMarkdownButtons.vue'
34

45
import './vars.css'
56
import './overrides.css'
@@ -11,6 +12,7 @@ const config: Theme = {
1112
app.config.globalProperties.$spec = {
1213
version: '2.0',
1314
}
15+
app.component('CopyOrDownloadAsMarkdownButtons', CopyOrDownloadAsMarkdownButtons)
1416
},
1517
}
1618

docs/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
},
1010
"devDependencies": {
1111
"unocss": "^66.5.6",
12-
"vitepress": "^1.6.4"
12+
"vitepress": "^1.6.4",
13+
"vitepress-plugin-llms": "^1.9.3"
1314
}
1415
}

0 commit comments

Comments
 (0)