feat(docs): add a plugin to generate documentation for LLMs (#2558)

Author: jay-es

.vitepress/config.ts

@@ -1,7 +1,8 @@
 import fs from 'fs'
 import path from 'path'
-import { defineConfigWithTheme, type HeadConfig } from 'vitepress'
+import { defineConfigWithTheme, type HeadConfig, type Plugin } from 'vitepress'
 import type { Config as ThemeConfig } from '@vue/theme'
+import llmstxt from 'vitepress-plugin-llms'
 import baseConfig from '@vue/theme/config'
 import { headerPlugin } from './headerMdPlugin'
 // import { textAdPlugin } from './textAdMdPlugin'
@@ -822,6 +823,30 @@ export default defineConfigWithTheme<ThemeConfig>({
     },
     json: {
       stringify: true
-    }
+    },
+    plugins: [
+      llmstxt({
+        ignoreFiles: [
+          'about/team/**/*',
+          'about/team.md',
+          'about/privacy.md',
+          'about/coc.md',
+          'developers/**/*',
+          'ecosystem/themes.md',
+          'examples/**/*',
+          'partners/**/*',
+          'sponsor/**/*',
+          'index.md'
+        ],
+        customLLMsTxtTemplate: `\
+# Vue.js
+
+Vue.js - The Progressive JavaScript Framework
+
+## Table of Contents
+
+{toc}`
+      }) as Plugin
+    ]
   }
 })

package.json

@@ -30,6 +30,7 @@
     "textlint-filter-rule-comments": "^1.2.2",
     "textlint-rule-preset-vuejs-jp": "github:vuejs-jp/textlint-rule-preset-vuejs-jp",
     "typescript": "^5.6.3",
+    "vitepress-plugin-llms": "^0.0.8",
     "vue-tsc": "^2.1.6"
   },
   "gitHooks": {

pnpm-lock.yaml

@@ -61,3 +61,8 @@
 /v2/guide/reactivity.html               /guide/extras/reactivity-in-depth.html
 
 /v2/*                                   https://v2.vuejs.org/v2/:splat?redirect=true    302
+
+/*.txt           /:splat.md 301
+/llms.md         /llms.txt 301
+/llms.txt        /llms.txt 200!
+/llms-full.txt   /llms-full.txt 200!