用途 create-docs 用于为项目生成完整、可直接投入生产的文档站点。当用户提出“create docs”“add documentation”“setup docs site”“generate docs”“document my…”等需求时使用。它基于 Nuxt Content 的 Docus 构建文档站。
工作流程 整体流程为:分析项目、初始化文档目录、生成文档页面、配置 AI 集成、收尾并给出下一步命令。
一、分析项目 检测项目结构,识别锁定文件与 monorepo 标志,例如 pnpm-workspace.yaml、turbo.json、lerna.json、nx.json、apps/、packages/,以及是否已存在 docs/、README.md、src/ 或 lib/。 根据项目类型确定文档目录:标准项目使用 ./docs;含 apps/ 的 monorepo 使用 ./apps/docs;含 packages/ 的 monorepo 使用 ./docs;若已存在 docs/ 目录,则询问用户或改用 ./documentation。 读取上下文文件:从 README.md 提取项目名称、描述、功能与用法示例;从 package.json 提取名称、描述、依赖与仓库地址;从 src/ 或 lib/ 提取导出的函数与 composables 用于 API 文档。 检测 i18n 需求:若依赖中有 @nuxtjs/i18n、存在 locales/ 或 i18n/ 目录、存在多语言 README,或用户明确提到多语言,则使用 i18n 模板,否则使用默认模板。
二、初始化文档 创建目录结构。默认模板包含可选的 app/(用于定制,含 app.config.ts、components、layouts、pages)、content/(index.md 与 1.getting-started/ 及 .navigation.yml、1.introduction.md)、public/favicon.ico、package.json 与 .gitignore。i18n 模板按语言划分 content/en/、content/fr/ 等,并需要 nuxt.config.ts 进行 i18n 配置。 生成 package.json,脚本为 dev/build/generate/preview,均使用 nuxt 相应命令并带 --extends docus;默认依赖 docus(latest)、better-sqlite3(^12.5.0)、nuxt(^4.2.2);i18n 场景额外加入 @nuxtjs/i18n(^10.2.1)。 在 i18n 场景创建 nuxt.config.ts,配置 modules 为 ['@nuxtjs/i18n'],以及 i18n 的 locales(含 code、language、name)与 defaultLocale。 创建 .gitignore,忽略 node_modules、.nuxt、.output、.data、dist。 如适用,更新 monorepo 配置:pnpm monorepo 需把 docs 加入 workspace packages,并为 better-sqlite3 配置 onlyBuiltDependencies,添加 docs:dev 脚本(可用 filter 或 cd 方式);npm/yarn monorepo 配置 workspaces 与 docs:dev 脚本。
三、生成文档 使用模板文件中的模板生成页面。注意 MDC 中所有 Nuxt UI 组件必须带 u- 前缀,例如 ::u-page-hero、::u-page-section、:::u-page-feature、:::u-button、::::u-page-card,缺少 u- 前缀会导致 Vue 无法解析组件。 文档结构通常包含 index.md 落地页,以及 1.getting-started/、2.guide/、3.api/ 等分节,每节含 .navigation.yml 与对应页面。页面类型包括:落地页(Hero 与功能网格)、介绍(是什么、为什么、使用场景)、安装(前置条件、安装命令)、指南(以动作型 H2 标题组织的功能文档)。
四、配置 AI 集成 Docus 自动包含 MCP server(/mcp)与 llms.txt 生成,无需额外配置。不要在落地页添加 AI Integration 部分;可选在介绍页用 note 组件提及该文档包含 MCP server 与自动 llms.txt 生成的 AI 集成。 可选通过 app.config.ts 配置 docus 的 name、description、url、socials(如 github)。可选进行主题定制,例如在 app/assets/css/main.css 中通过 @theme 设定字体、容器宽度与主色,或在 app.config.ts 中配置 ui.colors 与组件插槽样式。
五、收尾 按检测到的包管理器给出启动命令。标准项目:进入文档目录后执行 [pm] install 与 [pm] run dev,访问 http://localhost:3000。monorepo:在根目录执行 [pm] install 与 [pm] run docs:dev,或进入文档目录执行 [pm] run dev。 生成的站点包含全文搜索、深色模式、面向 AI 工具的 MCP server(/mcp)、LLM 集成(/llms.txt)与 SEO 优化。后续可检查生成内容、在 content/2.guide/ 增加指南、在 app.config.ts 定制主题,并部署到 Vercel/Netlify/Cloudflare。
部署命令 Vercel:npx vercel --prod,输出自动检测。Netlify、Cloudflare Pages、GitHub Pages:执行 [pm] run generate,输出目录为 .output/public。
示例 以 auth-utils 为例:检测为 pnpm monorepo,包位于 packages/ 下;生成的 docs/ 结构包含 content/index.md、1.getting-started/(介绍、安装)、2.guide/(认证、OAuth 提供商、会话)、3.api/(composables)、public/favicon.ico、package.json 与 .gitignore。authentication.md 中使用动作型 H2 标题,如“添加基础认证”“保护你的路由”“处理登录重定向”“自定义会话”。
限制 资料未说明具体的收费、价格与平台支持细节;实际生成内容取决于项目上下文与模板,未提供的功能应视为暂未提供。