@icebreakers/monorepo-templates 1.0.3 → 1.0.4

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@icebreakers/monorepo-templates",
   "type": "module",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Template assets for icebreaker monorepo scaffolding",
   "author": "ice breaker <hi@sonofmagic.top>",
   "license": "MIT",

package/templates/client/package.json

@@ -42,7 +42,7 @@
     "hono": "^4.12.18",
     "tailwindcss": "^4.2.4",
     "typescript": "~6.0.3",
-    "vite": "^8.0.10",
+    "vite": "^8.0.11",
     "vite-plugin-vue-devtools": "^8.1.1",
     "vite-tsconfig-paths": "^6.1.1",
     "vue-tsc": "3.2.8",

package/templates/client/vite.config.ts

@@ -1,3 +1,4 @@
+import type { PluginOption, UserConfig } from 'vite'
 import path from 'node:path'
 import { cloudflare } from '@cloudflare/vite-plugin'
 import Tailwindcss from '@tailwindcss/vite'
@@ -8,27 +9,32 @@ import VueDevTools from 'vite-plugin-vue-devtools'
 import VueRouter from 'vue-router/vite'
 
 // https://vite.dev/config/
-export default defineConfig(({ command }) => ({
-  build: {
-    target: 'baseline-widely-available',
-  },
-  resolve: {
-    alias: {
-      '@': path.resolve(import.meta.dirname, 'src'),
-      '~': import.meta.dirname,
-    },
-  },
-  plugins: [
-    VueRouter(
-      {
-        dts: path.resolve(import.meta.dirname, 'src/route-map.d.ts'),
-        watch: command === 'serve',
-      },
-    ),
+export default defineConfig(({ command }): UserConfig => {
+  const plugins: PluginOption[] = [
+    VueRouter({
+      dts: path.resolve(import.meta.dirname, 'src/route-map.d.ts'),
+      watch: command === 'serve',
+    }) as PluginOption,
     Vue(),
     VueJsx(),
     Tailwindcss(),
-    cloudflare(),
-    command === 'serve' ? VueDevTools() : null,
-  ],
-}))
+    cloudflare() as unknown as PluginOption,
+  ]
+
+  if (command === 'serve') {
+    plugins.push(VueDevTools() as unknown as PluginOption)
+  }
+
+  return {
+    build: {
+      target: 'baseline-widely-available',
+    },
+    resolve: {
+      alias: {
+        '@': path.resolve(import.meta.dirname, 'src'),
+        '~': import.meta.dirname,
+      },
+    },
+    plugins,
+  }
+})

package/templates/vitepress/.vitepress/config.ts

@@ -1,5 +1,6 @@
 import Tailwindcss from '@tailwindcss/vite'
 import { defineConfig } from 'vitepress'
+import llmstxt from 'vitepress-plugin-llms'
 import { withMermaid } from 'vitepress-plugin-mermaid'
 
 const repoctlSidebar = [
@@ -32,6 +33,12 @@ const repoctlSidebar = [
       { text: '改进并发布现代 npm 包', link: '/why/index' },
     ],
   },
+  {
+    text: 'AI',
+    items: [
+      { text: 'AI 文档入口', link: '/tools/llms-txt' },
+    ],
+  },
   {
     text: '工具专题',
     items: [
@@ -99,6 +106,7 @@ export default withMermaid(defineConfig({
           { text: '快速开始', link: '/repoctl/getting-started' },
           { text: '命令', link: '/repoctl/commands' },
           { text: '知识库', link: '/monorepo/' },
+          { text: 'AI 文档', link: '/tools/llms-txt' },
           { text: '工具专题', link: '/tools/turborepo' },
         ],
         outline: {
@@ -132,6 +140,7 @@ export default withMermaid(defineConfig({
           { text: 'Getting Started', link: '/en/repoctl/getting-started' },
           { text: 'Commands', link: '/en/repoctl/commands' },
           { text: 'Knowledge Base', link: '/en/knowledge/monorepo' },
+          { text: 'AI Docs', link: '/tools/llms-txt' },
         ],
         outline: {
           label: 'On This Page',
@@ -158,6 +167,7 @@ export default withMermaid(defineConfig({
     plugins: [
       // @ts-ignore
       Tailwindcss(),
+      llmstxt(),
     ],
   },
   mermaid: {},

package/templates/vitepress/en/index.md

@@ -15,6 +15,9 @@ hero:
     - theme: alt
       text: Commands
       link: /en/repoctl/commands
+    - theme: alt
+      text: AI Docs
+      link: /tools/llms-txt
 
 features:
   - title: Adopt existing workspaces
@@ -23,6 +26,8 @@ features:
     details: Scaffold libraries, apps, services, docs, and CLIs with interactive prompts or explicit template keys.
   - title: Make checks repeatable
     details: Preview and run local verification plans that match your lint, typecheck, build, test, and tsd workflow.
+  - title: AI-readable documentation
+    details: Generate llms.txt, llms-full.txt, and Markdown page output so AI coding tools can read the repoctl docs directly.
 ---
 
 ## Fast Path
@@ -54,4 +59,5 @@ pnpm check
 - [Configuration](./repoctl/config.md)
 - [Templates](./repoctl/templates.md)
 - [Workflows and CI](./repoctl/workflows.md)
+- [AI Docs: llms.txt](../tools/llms-txt.md)
 - [Knowledge Base: Why Monorepo](./knowledge/monorepo.md)

package/templates/vitepress/index.md

@@ -15,6 +15,9 @@ hero:
     - theme: alt
       text: 命令速查
       link: /repoctl/commands
+    - theme: alt
+      text: AI 文档入口
+      link: /tools/llms-txt
 
 features:
   - title: 从已有仓库开始
@@ -23,6 +26,8 @@ features:
     details: repo new 支持交互式创建、指定模板、dry-run、JSON 输出和创建计划落盘。
   - title: 把质量门禁变成日常命令
     details: repo check 统一预览和执行 lint、typecheck、build、test、tsd 等推荐校验。
+  - title: 给 AI 工具的文档入口
+    details: 构建时自动生成 llms.txt、llms-full.txt 和页面 Markdown，让 AI 编程工具更容易读取 repoctl 文档。
 ---
 
 ## 最短路径
@@ -54,4 +59,5 @@ pnpm check
 - [配置文件](./repoctl/config.md)
 - [模板与创建](./repoctl/templates.md)
 - [工作流与 CI](./repoctl/workflows.md)
+- [AI 文档入口：llms.txt](./tools/llms-txt.md)
 - [知识库：为什么往 monorepo 方向演进](./monorepo/index.md)

package/templates/vitepress/package.json

@@ -2,9 +2,9 @@
   "name": "@icebreakers/website",
   "type": "module",
   "version": "0.0.0",
-  "description": "https://monorepo.icebreaker.top source code",
+  "description": "https://repo.icebreaker.top source code",
   "author": "ice breaker <hi@sonofmagic.top>",
-  "homepage": "https://monorepo.icebreaker.top",
+  "homepage": "https://repo.icebreaker.top",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/sonofmagic/monorepo-template.git",
@@ -35,6 +35,7 @@
     "mermaid": "^11.14.0",
     "tailwindcss": "^4.2.4",
     "vitepress": "^1.6.4",
+    "vitepress-plugin-llms": "^1.12.2",
     "vitepress-plugin-mermaid": "^2.0.17"
   }
 }

package/templates/vitepress/tools/llms-txt.md

@@ -0,0 +1,29 @@
+---
+description: 使用 llms.txt 为大语言模型提供更易读取的 repoctl 文档入口。
+---
+
+# AI 文档入口：llms.txt
+
+`llms.txt` 是面向大语言模型的文档入口文件。它把站点中的关键页面整理成更适合模型读取的 Markdown 索引，便于 AI 工具在回答 repoctl、pnpm workspace、Turborepo 和模板用法相关问题时快速定位上下文。
+
+本站通过 `vitepress-plugin-llms` 在构建阶段自动生成这些文件：
+
+- `/llms.txt`：文档索引，列出可供模型读取的页面。
+- `/llms-full.txt`：把站点文档合并成单个文本文件。
+- 每个页面对应的 `.md` 文件：保留页面内容的 Markdown 版本。
+
+## 使用方式
+
+访问 `https://repo.icebreaker.top/llms.txt` 可以获取当前文档的 LLM 索引。如果需要一次性提供完整上下文，可以使用 `https://repo.icebreaker.top/llms-full.txt`。
+
+当你在 Cursor、Claude Code、Codex 或其他 AI 编程工具里引用 repoctl 文档时，优先提供 `llms.txt`，再按需要补充具体页面链接。
+
+## 维护约定
+
+新增重要文档页面时，在 frontmatter 中补充 `description`。构建插件会把描述写入 `llms.txt` 的链接说明中，让模型更容易判断每个页面的用途。
+
+```md
+---
+description: 说明这个页面解决的问题和适用场景。
+---
+```

package/templates/vitepress/why/examples/2.npm-basic-package/README.md

@@ -1 +1 @@
-https://monorepo.icebreaker.top/
+https://repo.icebreaker.top/

package/templates/vitepress/why/examples/3.npm-basic-package/README.md

@@ -1 +1 @@
-https://monorepo.icebreaker.top/
+https://repo.icebreaker.top/

package/templates/vitepress/wrangler.jsonc

@@ -0,0 +1,5 @@
+{
+  "$schema": "https://unpkg.com/wrangler/config-schema.json",
+  "name": "monorepo-template",
+  "pages_build_output_dir": ".vitepress/dist"
+}

package/templates/vue-lib/package.json

@@ -53,7 +53,7 @@
     "@vue/test-utils": "^2.4.10",
     "@vue/tsconfig": "^0.9.1",
     "jsdom": "^29.1.1",
-    "vite": "^8.0.10",
+    "vite": "^8.0.11",
     "vite-plugin-dts": "^5.0.0",
     "vue": "^3.5.34",
     "vue-tsc": "^3.2.8"