Docmd教程：零配置Markdown文档生成工具，支持AI Agent与MCP服务

大家好 这里是「代码简单说」,欢迎大家关注同名公众号,不定时更新更多实用有趣的教程 也欢迎大家在评论区一起讨论交流!~

关键词：Docmd、Markdown文档生成器、AI文档工具、MCP Server、llms.txt、Docusaurus替代方案、VitePress替代方案、文档站点生成、开发者文档、Node.js文档框架

最近在寻找一款轻量级文档生成工具时，发现了一个非常有意思的开源项目——Docmd。

很多开发者都有这样的经历：

项目刚开始时，觉得文档很简单，一个 README.md 就够了。

随着项目越来越大：

• 文档越来越多
• 目录越来越乱
• 搜索功能没有
• 多语言支持困难
• SEO配置繁琐
• AI工具无法理解项目文档

最后不得不引入：

• Docusaurus
• VitePress
• MkDocs
• Mintlify

但这些方案往往需要大量配置。

而今天介绍的 Docmd，主打的就是：

从 Markdown 到生产环境文档站，仅需一条命令。

---

项目介绍

Docmd 是一个面向开发者和 AI Agent 的新一代文档引擎。

项目地址：

名称	地址
GitHub	https://github.com/docmd-io/docmd
官网	https://docmd.io
文档	https://docs.docmd.io
在线编辑器	https://live.docmd.io

官方定位：

几秒钟内从 Markdown 构建生产就绪的文档。

特点包括：

• AI First
• 零配置
• 开箱即用
• SEO友好
• MCP支持
• Agent集成

---

为什么会出现Docmd？

目前主流文档方案存在一些共同问题。

Docusaurus

优点：

• 功能完善
• 社区成熟

缺点：

• React生态绑定
• 配置复杂
• 包体积较大

---

VitePress

优点：

• Vue生态
• 性能优秀

缺点：

• 多版本支持较弱
• 多项目管理困难

---

MkDocs

优点：

• Python生态成熟

缺点：

• 需要Python环境
• 插件依赖较多

---

Mintlify

优点：

• AI友好

缺点：

• SaaS依赖
• 自托管受限

---

而 Docmd 的目标很明确：

保持 Markdown 的简单性，同时具备现代文档平台能力。

---

快速开始

如果目录中已经有 Markdown 文件：

npx @docmd/core dev

启动后访问：

http://localhost:3000

即可直接浏览文档。

---

自动完成的事情

无需任何配置：

• 自动生成导航
• 自动解析目录结构
• 自动生成页面
• 自动建立路由
• 自动支持搜索

真正做到：

Markdown → 文档站

---

构建生产环境

开发完成后：

npx @docmd/core build

生成静态站点。

适用于：

• Nginx
• Cloudflare Pages
• Vercel
• Netlify
• GitHub Pages

等部署平台。

---

全局安装

npm install -g @docmd/core

安装后即可使用：

docmd dev

启动开发服务器。

docmd build

构建项目。

---

Docker部署

如果不想安装 Node 环境：

docker run -p 3000:3000 ghcr.io/docmd-io/docmd:latest

直接运行即可。

---

自动迁移功能

比较有意思的是：

Docmd 提供迁移命令。

docmd migrate

支持从：

• Docusaurus
• VitePress
• MkDocs

迁移到 Docmd。

对于已有项目来说非常方便。

---

一键部署配置生成

执行：

docmd deploy

自动生成：

• Docker配置
• Nginx配置
• Caddy配置

省去了大量部署工作。

---

项目结构

一个最简单的项目结构如下：

my-docs/
├── docs/
├── assets/
├── docmd.config.json
└── package.json

甚至：

my-docs/
└── README.md

也能直接运行。

---

核心功能解析

1. 零配置启动

无需：

vite.config.js

无需：

docusaurus.config.js

无需：

mkdocs.yml

直接运行即可。

---

2. SEO优化

Docmd内置：

• Sitemap
• Canonical URL
• Open Graph
• Redirect

对于搜索引擎非常友好。

自动生成：

sitemap.xml

无需额外插件。

---

3. 离线搜索

很多文档系统依赖：

• Algolia
• 云端搜索

而 Docmd 提供：

本地离线全文搜索

优势：

• 无第三方依赖
• 无网络请求
• 更快

---

4. 国际化支持

配置非常简单：

module.exports = defineConfig({
  i18n: {
    default: 'en',
    locales: [
      { id: 'en', label: 'English' },
      { id: 'zh', label: '中文' }
    ]
  }
});

官方支持：

• 中文
• 英文
• 日文
• 德文
• 法文
• 西班牙语
• 印地语

并支持扩展更多语言。

---

5. 版本管理

对于SDK文档非常重要。

配置：

versions: {
  current: 'v2',
  all: [
    {
      id: 'v2',
      dir: 'docs'
    },
    {
      id: 'v1',
      dir: 'docs-v1'
    }
  ]
}

即可同时维护多个版本文档。

---

AI时代最有价值的功能

相比传统文档工具。

Docmd最大的亮点其实是：

AI Context支持

自动生成：

llms.txt

以及：

llms-full.txt

让大模型快速理解项目。

这也是目前越来越多AI项目采用的新标准。

---

MCP Server

启动：

docmd mcp

即可提供原生 MCP 服务。

支持：

• 文档搜索
• 文档读取
• 内容验证

让 AI Agent 直接访问项目文档。

---

Agent Skills

官方提供：

docmd-skills

技能库。

可以直接接入：

• Claude
• Cursor
• Cline
• RooCode
• Windsurf

等Agent生态。

---

在线编辑器

官方还提供了在线版本：

https://live.docmd.io

特点：

• 浏览器运行
• 实时预览
• 无需安装
• 无需配置

对于编写教程非常方便。

---

插件生态

虽然主打零配置。

但 Docmd 依然支持扩展。

---

已内置插件

插件	功能
search	离线搜索
seo	SEO优化
sitemap	站点地图
git	Git历史记录
analytics	数据统计
llms	AI上下文生成
mermaid	Mermaid图表
openapi	OpenAPI渲染

---

可选插件

插件	功能
pwa	离线应用
threads	评论讨论
math	数学公式

安装：

docmd add pwa

即可完成扩展。

---

与主流文档工具对比

功能对比

特性	Docmd	Docusaurus	MkDocs	VitePress	Mintlify
零配置	√	×	×	×	×
多版本	√	√	插件	手动	√
国际化	√	√	插件	手动	√
离线搜索	√	×	√	√	×
MCP支持	√	×	×	×	√
AI上下文	√	×	×	×	√
Docker镜像	√	×	√	×	×
自托管	√	√	√	√	×

---

性能对比

官方数据显示：

工具	初始负载
Docmd	~18KB
MkDocs	~40KB
VitePress	~50KB
Mintlify	~120KB
Docusaurus	~250KB

Docmd明显更轻量。

---

编程方式调用

除了CLI。

还支持直接作为库使用。

const { build, buildLive } = require('@docmd/core');

await build('./docmd.config.json', {
  isDev: false
});

await buildLive();

适合：

• CI/CD
• 自动化脚本
• DevOps流水线

场景。

---

实际适合哪些项目？

经过体验，我认为比较适合：

开源项目文档

GitHub项目
SDK文档
组件库文档

---

API文档

OpenAPI
Swagger
接口文档

---

AI项目

Agent
MCP Server
Prompt工程
RAG项目

---

企业知识库

技术文档
内部规范
开发手册

---

总结

Docmd最大的优势并不是单纯的文档生成。

而是：

把传统文档系统与AI生态彻底打通。

相比传统方案：

• 配置更少
• 体积更小
• SEO更完善
• MCP原生支持
• AI Context内置
• Agent生态友好

如果你正在寻找：

• Docusaurus替代方案
• VitePress替代方案
• AI时代的文档平台

那么 Docmd 是一个值得关注的新项目。

项目地址：

https://github.com/docmd-io/docmd

感兴趣的同学可以体验一下，几乎只需要一条命令就能把 Markdown 变成完整的生产级文档站。