docmd 是一款基于 Markdown 的零配置文档站点生成器,号称从 Markdown 几秒构建生产级文档。内置搜索、SEO、Mermaid 图表等常用功能,支持多语言 i18n 和原生工作区,1.8k Stars 的轻量级文档方案,零配置启动让文档编写回归本质。

🎤 引言

做技术文档最痛苦的是什么?不是写,而是搭环境!

Docusaurus 配置复杂、VitePress 主题有限、MkDocs 插件一堆……每次新建文档站点,光是调试构建脚本就耗掉大半天。

今天安利一个宝藏工具——docmd,GitHub 1.8k Stars,主打"零配置启动+生产级输出"。npm 装完跑一条命令,文档站就起来了,贼快贼省心!


⭐ 核心功能

1. 零配置启动

docmd 的核心理念是"开箱即用"。创建一个文件夹丢几个 Markdown 文件进去,跑一条命令就完事:

npx @docmd/core dev

没有复杂的配置文件,不需要安装任何插件——search、seo、sitemap 这些常用功能全部内置。

2. 原生工作区支持

这才是 docmd 的杀手锏!一个仓库里管理多个独立文档项目:

{
  "workspace": {
    "projects": [
      { "prefix": "/", "src": "main-docs", "title": "Docs" },
      { "prefix": "/sdk", "src": "sdk-docs", "title": "SDK" }
    ]
  }
}

一次 build 直接输出完整站点,不需要 nginx 反向代理,不需要多套 CI 流水线。Docusaurus 要靠复杂插件才能实现类似功能,配置复杂度完全不在一个量级。

3. 真正能用的多语言

大多数文档工具的多语言支持都是半残——翻译了 6 种语言,结果未翻译的页面直接 404。

docmd 解决了这个问题:页面没翻译时会自动回退到默认语言,而不是甩给你一个 404。在切换器中也会自动禁用缺失语言,配上本地化的"未翻译"警告标注,体验非常顺滑。

4. 生产级内置功能

功能说明
search离线全文搜索,支持模糊匹配
seoSEO 标签+Open Graph 元数据
sitemap自动生成 sitemap.xml
gitGit 提交历史记录
analytics轻量级数据分析集成
llms.txtAI 上下文生成
mermaidMermaid 图表支持
openapiOpenAPI 3.x 规范渲染

这些在 VitePress/MkDocs 里要么靠插件,要么需要额外配置,docmd 一个命令全搞定。

5. 浏览器 CDN 集成

不想用 CLI?直接通过 CDN 把引擎嵌进现有 Web 应用:

<link rel="stylesheet" href="https://unpkg.com/@docmd/ui/assets/css/docmd-main.css">
<script src="https://unpkg.com/@docmd/live/dist/docmd-live.js"></script>

适合动态文档门户场景,不适合静态 SEO 网站。


📥 安装使用

环境要求:Node.js 18+

方式一:项目本地安装(推荐)

# 安装到项目
npm install -D @docmd/core

# 初始化项目(可选)
npx @docmd/core init

本地安装可以锁定版本,团队协作和 CI/CD 构建都更稳定。

方式二:全局安装

npm install -g @docmd/core

全局安装后,docmd 命令在任意位置都可用。

方式三:直接 npx(尝鲜用)

npx @docmd/core dev

常用命令:

docmd dev   # 启动本地开发服务器
docmd build # 构建静态输出

🎯 适用场景

  • 个人/开源项目文档:不想折腾配置,就想快速搭个文档站
  • SDK/API 文档多项目管理:一个仓库管多个产品的文档,各自独立版本控制
  • 多语言文档站:需要真正可用的 i18n,不是那种会 404 的半残品
  • 轻量级技术博客:用 Markdown 写,用 docmd 渲染,简洁高效

🔍 对比/替代方案

功能docmdDocusaurusVitePressMkDocs
原生工作区插件插件
零配置
真正可用的多语言
JS 体积~12 KB~200 KB~35 KB~25 KB
冷启动构建~1.2s~15s~2.5s~3.0s

docmd 的 12KB JS 对比 Docusaurus 的 200KB JS,差距不是一点点。3G 网络下文档都能秒开,中端手机解析 100KB JS 要 50ms,而 docmd 12KB 只需要 6ms。

Docusaurus 适合大型 React 团队,VitePress 适合 Vue 生态,docmd 适合追求轻量和零配置的场景。


⚠️ 注意事项

  1. 浏览器集成场景有限:通过 CDN 嵌入适合动态门户,不是静态 SEO 网站的最优选
  2. 主题自定义有上限:追求高度定制化 UI 的话,docmd 可能不够灵活,需要选 VitePress/Docusaurus
  3. 插件生态相对年轻:可选插件数量不如 Docusaurus/MkDocs 丰富,不过常用功能都已内置
  4. Windows PowerShell 用户:首次安装需要放开脚本执行权限:Set-ExecutionPolicy RemoteSigned -Scope CurrentUser

✅ 总结

docmd 走的是"小而美"路线——不求大而全,但求零配置启动+极速构建+真正可用的多语言。

对于不需要复杂 React/Vue 定制、只想快速搭建文档站点的团队和个人开发者来说,docmd 是一个值得一试的选择。

推荐指数:⭐⭐⭐⭐(扣一星是怕你用了就离不开)


官网https://docs.docmd.io
GitHubhttps://github.com/docmd-io/docmd