开箱即用,无需配置。

内置搜索、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!
:::

模块化插件生态

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

@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 直接生成流程图、顺序图和架构图。

专为自主 AI 编程智能体打造。

通过开放机器可读标准,将您的文档无缝提供给 Claude、Cursor、Windsurf 及定制大模型。

模型上下文协议

原生 MCP 服务端

允许 Claude Desktop、Cursor 和 Windsurf 通过 stdio 或 SSE 直接搜索、检查并读取您的完整文档。

$ npx @docmd/plugin-mcp
标准上下文分发

llms.txt 与 llms-full.txt

生成标准化的大模型提要,使任何语言模型单次请求即可获取完整文档,无需网页爬虫抓取。

Exported /site/llms.txt
智能体行动技能

智能体技能 (SKILL.md)

将可执行的命令行工作流、架构规范与代码模式封装为可被编程助手自动发现的技能文件。

$ npx docmd-skills
知识图谱

开放知识库 (okf.yaml)

将文档编译为机器可读的本体标签、概念图与语义知识包,专为多智能体协同工作流优化。

Exported okf.yaml bundle
使用您最喜爱的 AI 助手编写文档:
docmd Cloud · 492 次查询/分 · 3.4ms 99.9% 运行时间

通过免费的 docmd Cloud Relay 为文档增添 AI 助手能力

通过 GitHub 秒级接入。获得实时搜索分析、发现文档缺失空白,并安全转发 AI 助手查询。

  • AI 助手安全代理 – 自带密钥 (BYOK) 路由至 100+ 大模型,绝不在浏览器暴露密钥。
  • 文档洞察分析 – 发现热门搜索词、流量趋势与未覆盖的内容盲区。
  • 免费且免运维 – 通过 GitHub 账号数秒内快速连接,零服务器维护负担。
中继请求用量 实时查询记录
已连接
48 查询 / 分钟
18.4k 30天总量
3.4ms 平均延迟
99.9% 在线率
中继请求用量图
24h 7d 30d
30 天前 15 天前 峰值: 1,842 次/天
搜索 "如何使用 file:// 协议完全离线部署文档?" 142 次提问
Cursor "自定义 Callout 容器的配置 Schema 在哪里?" 98 次提问
缺失文档 "如何从 MkDocs Material 迁移至 docmd" 亟需页面
AI 代理: 活跃 (BYOK) 系统状态: 运行正常

公开构建。开发者自主掌控。

文档天然属于 Git,绝不应被困在专有 SaaS 的围墙花园之中。

坚定开源承诺
“文档是项目的智力核心。它理应作为纯 Markdown 文件保存在您的 Git 代码库中——永久留存、版本受控、清晰可查且永久免费。docmd 永远 100% 遵循 MIT 许可协议,绝不设置任何付费功能门槛。”
docmd 开源宣言
01 / 数据主权

数据自主主权

您的所有文档均以纯 Markdown 格式保存在 Git 仓库中。无专有数据库,无私有结构。若需迁移,您可完整干净地带走所有内容。

02 / 厂商无锁

零供应商锁定

编译为标准静态 HTML。免费部署到任意静态云平台或 CDN。零月费、零运行时外部依赖,绝无隐性开销。

03 / 宽松开放

宽松 MIT 许可

个人使用、开源项目和商业落地均完全免费。由坚信文档基础设施应当对所有人开放的工程师倾力打造。

生态与社区

与全球开源社区携手共建

由来自世界各地的独立开发者、代码贡献者以及赞助者共同驱动。

社区赞助者与支持者

帮助维持 docmd 100% 免费与完全开源。所有赞助资金将直接用于编译器性能优化、智能体协议标准制定以及无服务器中继设施建设。

常见问题

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

什么是 docmd?
docmd 是一个开源文档编译器。您只需提供一个 Markdown 文件夹并运行一条命令,它就能同时生成网站、搜索索引、AI 上下文和知识格式––无需配置。
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 许可。只需一条命令,即可拥有首个文档网站。