用途:这是一项用于为当前项目生成终端用户文档站的技能,基于 Docusaurus 3.x。当用户要求创建文档、生成 docs 时使用。
主要能力:分析项目结构与现有文档,识别功能、配置与包结构;初始化新的 Docusaurus 3.x 项目(或复用已有项目);生成文档内容并组织目录结构;配置站点、主题与导航;支持 i18n 多语言、版本管理、本地搜索与博客;构建并预览文档站。
必要用法:
- 分析项目:查看 README.md、*.md、docs/、package.json 等。
- 初始化:npx -y create-docusaurus@latest docs-site classic --typescript
- 构建预览:cd docs-site;npm install;npm run start;npm run build;npm run serve
- 版本:npm run docusaurus docs:version 1.0.0
- 本地搜索:npm install @easyops-cn/docusaurus-search-local
- 翻译:npm run write-translations -- --locale vi;npm run start -- --locale vi
适用场景:需要为项目快速产出面向终端用户的文档网站时。
限制:资料未提供该技能的收费、价格、效果数据及具体平台限制,暂未提供。