用途:该技能生成独立的 VitePress 教程站点,讲解代码库的内部实现原理,区别于说明“如何使用”的用户文档,侧重“如何实现”。
主要能力:自动检测项目类型(语言、框架、monorepo 结构);深度分析源码目录,识别关键组件、架构模式、依赖关系与数据流;生成带 Mermaid 架构图、时序图和流程图的文档;引用真实源码并标注 file:line;支持 Go、TypeScript、Python 代码高亮与行高亮;支持最多两种内容语言(中文、英文、日文、韩文),双语言时使用 VitePress i18n 与语言切换器;生成可独立部署的站点。
使用方式:命令为 /vitepress-tutorial [task-description],例如 /vitepress-tutorial 帮我解析这个仓库的架构。工作流分三阶段:先分析项目并确认输出目录、教程重点与内容语言,随后创建骨架并运行 pnpm install;再进行深度分析;最后生成内容并构建验证。创建项目时需写入 package.json(含 mermaid、vitepress、vitepress-plugin-mermaid 依赖)、.vitepress/config.ts(使用 withMermaid 包装,并在 vite.optimizeDeps 中包含 mermaid 与 dayjs 以修复 dayjs 的 ESM 兼容问题),若处于其他 pnpm workspace 内还需写入 pnpm-workspace.yaml(packages: [])。安装命令为 cd {output-path} && pnpm install。
适用场景:为源码学习、架构解析、内部实现讲解生成教程站点。
限制:内容语言最多两种,超出需缩减;内容语言仅影响正文,代码片段、文件路径与技术术语保持英文;需先探索源码再写作;每章建议聚焦单一概念,约 200-400 行。其他收费、平台与效果信息暂未提供。