docmd

什么是 docmd？

docmd 是一款开源文档编译器，可将 Markdown 源文件树构建为静态文档网站及其他机器可读的文档输出。它面向需要让同一份源内容同时服务人类读者、搜索系统、LLM、编程代理和知识工具的项目。

该工具根据 Markdown 文件结构生成网站导航，基本工作流无需配置文件、frontmatter 或框架。其面向编译器的方式将源文件树和生成的输出置于同一构建流水线中，无需分别维护网站和 AI 知识技术栈。

除网站外，docmd 还可以生成离线搜索索引、llms.txt 和 llms-full.txt、Open Knowledge Format（OKF）输出、站点地图和 SEO 元数据、robots.txt、Open Graph 元数据、供 AI 代理使用的 MCP 接口，以及 AI 助手上下文。源文档将这些内容描述为文档构建的输出。

docmd 能做什么？

以 Markdown 为核心的编译

将包含 Markdown 文件的文件夹交给 docmd，即可将源文件树编译为文档。基本设置无需配置文件、frontmatter 或框架。

生成静态文档网站

构建过程会生成静态网站，并根据源文件结构生成导航，适合部署到静态托管平台。

搜索与发现输出

docmd 可以生成离线搜索索引，以及用于网站发现和分享的站点地图、SEO 元数据、robots.txt 和 Open Graph 元数据。

AI 与知识格式

同一份源内容可以生成 llms.txt、llms-full.txt、Open Knowledge Format 输出和 AI 助手上下文，用于面向机器的文档工作流。

通过 MCP 提供代理访问

文档化的输出流水线包含供 AI 代理使用的 MCP 接口，使文档项目除网页和文件外，还能提供面向代理的接口。

本地、软件包和容器工作流

仓库文档介绍了通过 npx、全局 npm 或 pnpm 安装，以及 ghcr.io/docmd-io/docmd Docker 镜像运行 docmd 的方式。快速入门示例中的开发服务器使用 3000 端口。

使用场景

“发布项目文档”

在源文件夹中维护 Markdown 文件，并将其编译为可导航的静态网站，方便用户在浏览器中阅读产品或项目文档。

“创建供机器检索的文档”

当同一份文档还需要供 LLM、面向 RAG 的知识系统或其他自动化工具使用时，采用生成的 llms.txt、llms-full.txt 或 Open Knowledge Format 输出。

“支持编程代理工作流”

使用文档化的 MCP 接口和 AI 助手上下文输出，让编程代理能够访问项目文档，同时保留面向人类的网站。

“在本地开发和预览文档”

针对 Markdown 文件夹运行 dev 命令，在 3000 端口打开本地服务器，并在创建部署构建前迭代源内容。

“部署静态文档构建”

运行构建命令，并通过受支持的静态托管平台或 NGINX、Caddy 等自管理服务器发布生成的静态网站。

常见问题

docmd 使用什么作为源内容？

docmd 使用包含 Markdown 文件的文件夹。在基本快速入门工作流中，导航根据文件结构生成，无需配置文件、frontmatter 或框架。

除了网站，docmd 还能生成什么？

文档列出的输出包括离线搜索索引、llms.txt、llms-full.txt、Open Knowledge Format 输出、站点地图和 SEO 元数据、robots.txt、Open Graph 元数据、供 AI 代理使用的 MCP 接口，以及 AI 助手上下文。

如何在本地试用 docmd？

快速入门使用 `npx @docmd/core dev`，指定一个 Markdown 文件夹，然后打开 `http://localhost:3000`。源文档还介绍了使用 npm 或 pnpm 进行全局安装。

生成的网站可以部署到静态托管平台吗？

可以。文档中的构建命令是 `npx @docmd/core build`。源文档列出了 Vercel、Cloudflare Pages、Netlify、GitHub Pages、S3、NGINX、Caddy 和其他静态托管平台作为部署选项。

docmd 是否需要 Node.js？

仓库快速入门文档说明，docmd 需要 Node.js 20 或更高版本。文档还将 Docker 镜像列为另一种运行方式。