Skip to content

Commit c8d9fc8

Browse files
committed
feat: add llm.txt
1 parent fa2233e commit c8d9fc8

File tree

5 files changed

+675
-3
lines changed

5 files changed

+675
-3
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
node_modules
2+
.vscode
23
.vitepress/cache
34
.vitepress/dist

.vitepress/config.mts

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import { defineConfig } from 'vitepress'
22
import type { DefaultTheme } from 'vitepress'
3+
import llmstxt from 'vitepress-plugin-llms'
34
import cangjie from './cangjie.tmLanguage.json'
45

56
const GUIDES: DefaultTheme.NavItemWithLink[] = [
@@ -8,6 +9,7 @@ const GUIDES: DefaultTheme.NavItemWithLink[] = [
89
{ text: '安装', link: '/guide/install' },
910
{ text: '命令行使用', link: '/guide/command_line' },
1011
{ text: '已知限制', link: '/guide/limitation' },
12+
{ text: 'LLM', link: '/guide/llm' },
1113
]
1214

1315
export default defineConfig({
@@ -30,7 +32,12 @@ export default defineConfig({
3032
detailsLabel: '详细信息'
3133
}
3234
},
33-
35+
vite: {
36+
plugins: [llmstxt({
37+
domain: 'https://cjbind.zxilly.dev',
38+
description: 'cjbind 是一个自动生成仓颉到 C 库的 FFI 绑定代码的工具',
39+
})]
40+
},
3441
themeConfig: {
3542
siteTitle: 'cjbind',
3643
nav: [
@@ -84,7 +91,7 @@ export default defineConfig({
8491

8592
footer: {
8693
message: '以 MIT 许可证发布',
87-
copyright: '版权所有 © 2024 - 现在 Zxilly',
94+
copyright: `版权所有 © 2024 - ${new Date().getFullYear()} Zxilly`,
8895
},
8996

9097
docFooter: {

guide/llm.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# 关于 AI
2+
3+
此文档支持 [llm.txt](https://llmstxt.org/) 协议,你可以访问 [llm.txt](/llm.txt) 来获取更多信息。
4+
5+
你可以将此链接提供给任何支持此协议的 AI 模型,模型将能够理解和使用此文档中的信息。

package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
"license": "ISC",
1414
"packageManager": "[email protected]",
1515
"devDependencies": {
16-
"vitepress": "2.0.0-alpha.5"
16+
"vitepress": "2.0.0-alpha.5",
17+
"vitepress-plugin-llms": "^1.1.3"
1718
}
1819
}

0 commit comments

Comments
 (0)