Merge pull request #2454 from hey-api/docs/llms

docs: add llm-friendly output

Author: mrlubos

docs/.vitepress/config/shared.ts

@@ -1,4 +1,5 @@
 import { defineConfig, type HeadConfig } from 'vitepress';
+import llmstxt from 'vitepress-plugin-llms';
 
 const domain = process.env.SITE_DOMAIN || 'http://localhost:5173';
 
@@ -106,4 +107,13 @@ export default defineConfig({
       ],
     );
   },
+  vite: {
+    plugins: [
+      llmstxt({
+        experimental: {
+          depth: 2,
+        },
+      }),
+    ],
+  },
 });

docs/package.json

@@ -17,6 +17,7 @@
   "devDependencies": {
     "sharp": "0.33.5",
     "vitepress": "2.0.0-alpha.11",
+    "vitepress-plugin-llms": "1.7.3",
     "vue": "3.5.13"
   }
 }

examples/openapi-ts-axios/package.json

@@ -35,6 +35,6 @@
     "prettier": "3.4.2",
     "tailwindcss": "3.4.9",
     "typescript": "5.8.3",
-    "vite": "6.2.7"
+    "vite": "7.1.2"
   }
 }

examples/openapi-ts-fastify/package.json

@@ -18,7 +18,7 @@
     "eslint": "9.17.0",
     "prettier": "3.4.2",
     "typescript": "5.8.3",
-    "vite": "6.2.7",
+    "vite": "7.1.2",
     "vitest": "3.1.1"
   }
 }

examples/openapi-ts-fetch/package.json

@@ -34,6 +34,6 @@
     "prettier": "3.4.2",
     "tailwindcss": "3.4.9",
     "typescript": "5.8.3",
-    "vite": "6.2.7"
+    "vite": "7.1.2"
   }
 }

examples/openapi-ts-nuxt/package.json

@@ -19,6 +19,6 @@
     "zod": "4.0.5"
   },
   "devDependencies": {
-    "vite": "6.2.7"
+    "vite": "7.1.2"
   }
 }

examples/openapi-ts-sample/package.json

@@ -36,6 +36,6 @@
     "prettier": "3.4.2",
     "tailwindcss": "3.4.9",
     "typescript": "5.8.3",
-    "vite": "6.2.7"
+    "vite": "7.1.2"
   }
 }

examples/openapi-ts-tanstack-react-query/package.json

@@ -36,6 +36,6 @@
     "prettier": "3.4.2",
     "tailwindcss": "3.4.9",
     "typescript": "5.8.3",
-    "vite": "6.2.7"
+    "vite": "7.1.2"
   }
 }

examples/openapi-ts-tanstack-svelte-query/package.json

@@ -37,7 +37,7 @@
     "svelte-check": "4.1.4",
     "typescript": "5.8.3",
     "typescript-eslint": "8.29.1",
-    "vite": "6.2.7",
+    "vite": "7.1.2",
     "vitest": "3.1.1"
   }
 }

examples/openapi-ts-tanstack-vue-query/package.json

@@ -43,7 +43,7 @@
     "prettier": "3.4.2",
     "tailwindcss": "3.4.9",
     "typescript": "5.8.3",
-    "vite": "6.2.7",
+    "vite": "7.1.2",
     "vite-plugin-vue-devtools": "7.7.0",
     "vitest": "3.1.1",
     "vue-tsc": "2.2.0"