Kodadocs

KodaDocs

kodadocs.com | 文档 | 为你的 Web 应用生成 AI 帮助文档——只需几分钟，无需几周。

KodaDocs 是一款开源的 Claude Code MCP 工具。安装后，告诉 Claude“为我的应用生成文档”，即可获得完整的帮助中心，其中包含带注释的截图和 AI 撰写的文章。可免费自托管。Pro Kit（$29）提供不限量页面、12 个技能工作流和所有高级主题。还可选用托管部署（$5/月），部署到 yourapp.kodadocs.com。

快速开始

将 MCP 服务添加到 Claude Code 配置（~/.claude/settings.json）中：

{
  "mcpServers": {
    "kodadocs": {
      "command": "uvx",
      "args": ["kodadocs", "mcp"]
    }
  }
}

安装浏览器以截取屏幕截图（仅需一次）：

uvx --with kodadocs playwright install chromium

然后告诉 Claude：

“为我的应用生成帮助文档”

Claude 会读取你的代码、截取屏幕截图、撰写文档，并组装 VitePress 帮助中心——这一切都通过 MCP 工具完成。

CLI（可选）

适合希望直接使用 CLI 的高级用户：

pip install kodadocs
kodadocs generate .
kodadocs deploy .

示例展示

查看 KodaDocs 生成的文档——这些文档在不到 2 分钟内创建完成：

项目	框架	在线文档
Hono	Hono	hono.kodadocs.com
Drizzle	Drizzle ORM	drizzle.kodadocs.com
Create T3 App	Next.js	create-t3-app.kodadocs.com

想让你的项目也展示在这里吗？使用 KodaDocs 生成文档，然后告诉我们。

工作原理

Your web app ──► KodaDocs ──► Complete help center
                   │
                   ├── Detects framework (Next.js, Django, Flask, WordPress, ...)
                   ├── Discovers routes from source code
                   ├── Launches headless browser & authenticates
                   ├── Captures screenshots with PII blurring
                   ├── Draws numbered callouts on UI elements
                   ├── Claude writes all articles
                   └── Assembles VitePress site & deploys

阶段	处理内容
发现	检测框架，从代码中发现路由
截取	启动无头浏览器、进行身份验证并截取屏幕截图
注释	在 UI 元素上绘制带编号的标注
撰写文档	Claude 撰写所有文章（入门指南、功能指南、常见问题、故障排除）
组装	组装带有品牌元素、搜索功能和移动端布局的 VitePress 站点
部署	部署到 Cloudflare、Vercel、Netlify、GitHub Pages 或 kodadocs.com

支持的框架

Next.js、Nuxt、React、Vue、Angular、SvelteKit、Remix、Astro、Django、Flask、FastAPI、Rails、Laravel、Express、Hono、WordPress、Chrome 扩展等。

MCP 工具

工具	说明
detect_framework	根据项目文件自动检测 Web 框架
discover_routes	对路由、服务和元数据进行静态分析
analyze_codebase	使用 Tree-sitter 解析代码片段、错误模式和数据模型
capture_screenshots	使用无头浏览器截屏，支持身份验证和 PII 模糊处理
annotate_screenshots	通过 Pillow 在 UI 元素上添加带编号的标注
assemble_vitepress	根据文章和屏幕截图构建完整的 VitePress 站点
deploy_site	部署到托管服务提供商
save_manifest / load_manifest	保存并加载流水线状态

Claude Code 技能

KodaDocs 包含一个技能文件，用于指导 Claude 编排完整流水线。安装方法：

mkdir -p .claude/skills
cp kodadocs/skill/kodadocs.md .claude/skills/kodadocs.md

CLI

KodaDocs 也可以作为独立 CLI 使用（需要 pip install kodadocs）：

kodadocs generate .                              # Run full pipeline
kodadocs generate . --url http://localhost:3000   # Override app URL
kodadocs generate . --user admin --pass secret    # Auth-gated apps
kodadocs deploy . --provider cloudflare           # Deploy to provider
kodadocs init .                                   # Interactive setup wizard
kodadocs config .                                 # View/update config
kodadocs mcp                                      # Start MCP server

需要身份验证的应用

KodaDocs 会自动处理需要登录的应用：

1. 通过 kodadocs init 或 --user / --pass 标志提供凭据
2. KodaDocs 通过无头浏览器登录并保存会话
3. 身份验证后的爬取会发现未登录访客无法看到的路由
4. 所有截图均在已通过身份验证的会话中采集

API 密钥

KodaDocs 需要 Anthropic API 密钥 来生成文档。

使用 Claude Code（MCP）： API 密钥会自动提供，无需设置。

使用 CLI： 在环境中设置密钥：

export ANTHROPIC_API_KEY=sk-ant-...

定价

功能	免费版	Pro Kit（$29）	+ 托管服务（$5/月）
每次生成的页面数	15	不限	不限
框架	全部 18+	全部 18+	全部 18+
主题	默认	全部 6+ 个高级主题	全部 6+ 个高级主题
自定义品牌	否	是	是
需要身份验证的应用	否	是	是
技能文件	—	12 个专业工作流	12 个专业工作流
徽章	始终显示	可移除	可移除
自托管部署	是	是	是
托管服务	—	—	yourapp.kodadocs.com
自定义域名	—	—	help.yourapp.com
搜索分析	—	—	是

用户自备 Anthropic API 密钥，生成过程始终不受限制。

获取 Pro Kit — 页面数量不限、高级主题，以及 12 个专业技能工作流。

贡献

开发环境设置和指南请参阅 CONTRIBUTING.md。

许可证

MIT