v0.8.5现已推出

Markdown 到生产文档。
一条命令。零配置。

静态 HTML 优化 SEO。SPA 速度导航。默认 AI 就绪。
无需 React。无框架锁定。无学习成本。

开始使用 Get Started
< 20kb JS Lighthouse 100 零配置 离线搜索

部署到 GitHub Pages

几秒内让您的文档上线 — 无需后端、无需服务器、完全免费。

最简单 — 新仓库

🗂 模板

使用预配置的新文档仓库开始。一键创建,推送即部署。

使用模板 →
灵活 — 现有仓库

⚡ GitHub Action

在工作流中添加一个步骤。适用于任何项目结构,包括 monorepo。

- uses: docmd-io/deploy@v1.1
在 Marketplace 查看 →
快速入门

零配置启动。需要时完全掌控。

运行一条命令。获得生产文档站点。之后用简单的配置文件自定义 — 无模板代码,无框架锁定。

  • 一条命令完成设置:npx @docmd/core init
  • 可选的 docmd.config.js 实现完全自定义
  • 兼容任何现有 Markdown 结构
安装指南 →
Terminal
$ npx @docmd/core dev
 Built in 340ms — 12 pages
→ http://localhost:3000
内容

无需 HTML 的富布局。

使用原生 Markdown 容器语法编写提示框、标签页、卡片等。复杂布局,零 HTML。

  • 提示框、警告框和信息框
  • 带语法高亮的标签页内容
  • 卡片网格和布局容器
  • 所有容器类型支持图标
容器文档 →
⚠️ Warning

Be careful with this setting. It affects all deployments.

ℹ️ Note

This feature requires docmd v0.7.0 or later.

JavaScript
Python
Go
npm install @docmd/core
Quick Start
Get running in under 2 minutes
Configuration
Customize every aspect
搜索

即时搜索。无需 API 密钥。100% 离线。

每个站点内置全文模糊搜索。无云依赖,无 API 费用。完全离线运行,支持多语言索引。

  • 跨所有内容的模糊匹配
  • 快捷键 ⌘K 打开
  • 按语言独立搜索索引
搜索插件文档 →
生产就绪

i18n、主题、版本管理和一键部署。

生产文档所需的一切 — 多语言支持、明暗主题、版本切换,以及 Docker、Nginx 和 Caddy 的部署配置。

  • 原生 i18n,语言优先 URL
  • 明暗主题,支持自定义 CSS
  • 多版本文档支持
  • docmd deploy 生成生产配置
配置文档 →
Light
Dark
Terminal
$ docmd deploy --docker
 Generated Dockerfile
 Generated nginx.conf
  → docker build -t docs .

满足每种文档需求。

从开源 README 到企业知识库。

开发者文档

为您开源项目或产品提供的 API 参考、指南和教程。

知识库

内部维基、团队文档以及带有搜索和版本控制的入职指南。

API 参考

原生 OpenAPI 支持,结构化的端点文档,包含代码示例、选项卡和语法高亮。

技术指南

带有标注、警告和多语言代码示例的分步教程。

AI Agent 工作区

原生 MCP 服务器、SKILL.md Agent 指令和 llms-full.txt 上下文 — 让 AI Agent 可以直接搜索、读取和编写您的文档。

更新日志

精美的发布时间线,包含版本历史和结构化的发布说明。

一切内置。

核心插件默认包含。按需添加可选插件。

常见问题

关于 docmd 常见问题的快速解答。

什么是 docmd?
docmd 是一个开源的零配置文档引擎,将 Markdown 文件转换为生产就绪的文档站点。阅读快速入门指南 →
与 Docusaurus 或 VitePress 有何不同?
docmd 零配置 — 无需 React、Vue 或框架知识。查看完整对比 →
需要 React 或任何框架吗?
不需要。docmd 无框架依赖。编写 Markdown,运行一条命令,即可获得生产站点。
AI 就绪功能如何工作?
docmd 自动生成 llms.txt 和 llms-full.txt 文件,为 AI 模型提供结构化上下文。了解 LLMs 插件 →) so AI agents can search, read, and validate your docs live. It auto-generates llms.txt and llms-full.txt context files, and docmd init creates a SKILL.md instruction file for coding agents.

MCP server docs →
docmd 是免费的吗?
是的。完全免费且开源,采用 MIT 许可证。在 GitHub 上查看 →
可以使用现有的 Markdown 文件吗?
可以。将 docmd 指向任何 Markdown 文件目录即可。Markdown 语法参考 →
docmd 支持多语言吗?
支持。原生 i18n,语言优先 URL,按语言搜索索引。i18n 配置 →

用您喜欢的 AI 写文档

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

省略 [skill-dir] 可安装到 ./docmd-skills/(或传入其他目标路径,如 – ~/.claude/skills/docmd) to install in ./docmd-skills/ (or pass other targets like – ~/.claude/skills/docmd)

准备好写更好的文档了吗?

加入使用 docmd 构建快速、精美文档的开发者行列。

社区赞助商