文档站点生成器Skill docs-site-generator

---

name: docs-site-generator description: 使用Docusaurus、MkDocs或VuePress生成文档站点 allowed-tools:

• Bash
• Read
• Write
• Glob

---

文档站点生成器技能

概述

使用流行的框架（Docusaurus、MkDocs、VuePress）生成文档站点，支持自定义主题配置和搜索集成。

能力

• 生成Docusaurus文档站点
• 生成MkDocs文档站点
• 支持VuePress
• 自定义主题配置
• 搜索集成（Algolia、本地）
• 版本控制支持
• 多语言支持
• 侧边栏自动生成

目标流程

• c4模型文档
• API设计规范
• 可观测性实施

输入模式

{
  "type": "object",
  "required": ["framework", "docsPath"],
  "properties": {
    "framework": {
      "type": "string",
      "enum": ["docusaurus", "mkdocs", "vuepress"],
      "default": "docusaurus"
    },
    "docsPath": {
      "type": "string",
      "description": "文档源文件路径"
    },
    "outputDir": {
      "type": "string",
      "description": "生成站点的输出目录"
    },
    "config": {
      "type": "object",
      "properties": {
        "title": { "type": "string" },
        "description": { "type": "string" },
        "baseUrl": { "type": "string" },
        "theme": { "type": "string" },
        "search": {
          "type": "object",
          "properties": {
            "provider": {
              "type": "string",
              "enum": ["algolia", "local"]
            }
          }
        },
        "versioning": {
          "type": "boolean",
          "default": false
        }
      }
    }
  }
}

输出模式

{
  "type": "object",
  "properties": {
    "outputDir": {
      "type": "string"
    },
    "configPath": {
      "type": "string"
    },
    "pages": {
      "type": "array",
      "items": { "type": "string" }
    },
    "buildCommand": {
      "type": "string"
    }
  }
}

使用示例

{
  kind: 'skill',
  skill: {
    name: 'docs-site-generator',
    context: {
      framework: 'docusaurus',
      docsPath: 'docs',
      outputDir: 'website',
      config: {
        title: '项目文档',
        baseUrl: '/docs/',
        theme: '@docusaurus/theme-classic'
      }
    }
  }
}