[go: up one dir, main page]
为何选择 docmd

开箱即用，无需配置。

内置搜索、SEO、主题和 AI 工具。按需开启所需功能。

编写 Markdown，获取网站

将 docmd 指向任意 Markdown 文件夹。它能瞬间构建出包含导航、热重载且无需配置的完整文档网站。

$ docmd build --offline
✓ Generated 12 pages in 340ms (Lighthouse 100)

原生 AI Agent 支持

通过内置 MCP 服务和自动生成的上下文文件，为 Claude、Cursor 和 Windsurf 等 AI 编码助手公开文档。

docmd mcp — Ready for Claude & Cursor

内置搜索，零云端成本

在构建时编译为本地索引文件的语义和关键字搜索。完全在浏览器中运行，无需云 API，无需托管成本。

Press ⌘K to search docs

从纯 Markdown 到丰富内容

使用简单的 Markdown 容器语法编写标注、代码标签页、警告框、卡片和图表。无需 HTML 或 JSX。

::: callout info
Native Markdown callouts & tabs!
:::
AI 与开放生态

一流的 AI 工具链。绝无绑定。

向 AI Agent 公开文档、嵌入 AI 助手并自动生成上下文文件——全由您自带 Key 控制。

BYOK 安全性

嵌入式 AI 助手

为您的网站添加理解文档的 AI 助手。它能读取您的内容，在上下文范围内回答用户提问，并通过安全的服务端 Key 管理支持 100+ 大语言模型。

plugin-ai: { provider: "byok" }
Model Context Protocol

面向 AI Agent 的 MCP 服务

允许 Claude、Cursor 和 Windsurf 等 AI 开发者工具通过 Model Context Protocol 直接搜索和读取您的文档。

$ npx @docmd/plugin-mcp
机器可读上下文

自动生成 AI 上下文

自动生成 llms.txt、llms-full.txt 和 SKILL.md 文件，让任何大语言模型都能理解您的文档结构。

✓ Exported /site/llms.txt
模块化生态

模块化插件生态

每个插件均可开箱即用，无需配置。仅开启您所需的功能。

@docmd/plugin-search

离线向量搜索

完全在浏览器中运行的语义与关键字搜索。

@docmd/plugin-mcp

MCP 服务

让 AI 助手直接搜索和读取您的文档。

@docmd/plugin-ai

AI 助手

以您的文档为上下文回答问题的 AI 助手。

@docmd/plugin-llms

AI 上下文生成器

为 AI 工具自动生成 llms.txt、llms-full.txt 和 SKILL.md。

@docmd/plugin-openapi

OpenAPI & Swagger 文档

根据 OpenAPI 规范文件生成交互式 API 参考页面。

@docmd/plugin-seo

SEO & Schema JSON-LD

Sitemap、Meta 标签和结构化数据，全面提升搜索引擎可见度。

@docmd/plugin-math

KaTeX 数学公式

使用轻量级 KaTeX 渲染 LaTeX 数学表达式。

@docmd/plugin-mermaid

Mermaid 图表

根据 Markdown 直接生成流程图、顺序图和架构图。

性能基准

极轻量化设计

无框架额外开销。纯静态 HTML 输出。

340 ms
构建时间
从 Markdown 到静态 HTML 的全站编译。
< 25 KB
客户端大小
发送到浏览器的 JavaScript 总容量。无需框架运行时。
0 MB
框架开销
输出结果中绝无 React、Vue 等框架依赖。
部署

数秒内部署至任何地方

静态 HTML 文件，可在任何托管平台上运行。无需服务器运行时。

GitHub Pages 模板

一键创建包含自动化 GitHub Actions 的预配置文档仓库。

使用模板 →

Docker & Nginx 配置

一条命令生成用于文档网站的 Dockerfile 和 Nginx 配置。

$ docmd deploy --docker

使用您喜爱的 AI 编写文档

为您的工具选择最佳的上下文来源。

Claude ChatGPT Gemini DeepSeek Agent Skills (SKILL.md)

常见问题

关于 docmd 您需要了解的一切。

什么是 docmd？
docmd 是一个开源文档引擎。您只需提供一个包含 Markdown 文件的文件夹并运行一条命令，它就能生成包含搜索、SEO 和导航的完整文档网站——无需框架或配置。
docmd 与 Docusaurus、MkDocs 或 VitePress 有何不同？
docmd 无需配置，也不需要 React 或 Vue 知识。它生成独立 HTML 页面，客户端 JS 小于 25 KB，Lighthouse 得分为 100，并开箱即用支持搜索、SEO 和 AI 上下文生成。
我需要 React 或前端框架吗？
不需要。docmd 完全不依赖框架。您只需编写 Markdown，运行一条命令即可获得纯 HTML 的生产级网站。
AI Agent 集成是如何工作的？
docmd 内置 MCP 服务，允许 Claude、Cursor 和 Windsurf 等 AI 工具直接搜索和读取您的文档。它还会自动生成 llms.txt 和 SKILL.md 文件。
什么是 Agent Skills (SKILL.md)？如何安装？
Agent Skills 是 AI 编码助手（Claude, Cursor, Windsurf）用于读取并理解如何操作项目的指令文件。通过以下命令安装官方 Skill：

npx docmd-skills [目标目录]

几分钟内开始构建

开源，MIT 许可。只需一条命令，即可拥有首个文档网站。

阅读文档 在 GitHub 点赞

社区赞助商