docmd-io/docmd

docmd – 为人类和机器打造的文档

是什么

• 一个开源编译器，可将一组纯 Markdown 文件夹转换为功能齐全的静态文档网站 以及 一组机器可读的产物。
• 相同的源文件会输出为：
  • HTML 网站（SPA 风格，支持亮/暗模式）
  • 离线搜索索引（关键词 + 可选向量搜索）
  • llms.txt / llms-full.txt – 专为喂给大语言模型（LLM）设计的纯文本转储文件
  • 用于 RAG 流水线的开放知识格式（OKF）包
  • 用于编码代理的 MCP 服务器接口
  • SEO 资产（站点地图、Open Graph、robots.txt）

为何对 AI / LLM 工作流至关重要

• 现代文档需要同时服务三类受众：人类、搜索引擎，以及执行检索增强生成（RAG）的 AI 代理。
• docmd 在一次处理中生成所有这些输出，将 Markdown 源文件作为唯一真实来源。
• 它自带一个 基于 RAG 的 AI 助手，可使用生成的 llms.txt 上下文回答问题，并提供一个 云中继服务，让助手与任何 LLM 提供商通信，而无需将凭据暴露给浏览器。

核心功能（面向人类）

• 零配置启动：npx @docmd/core dev 即可立即提供实时预览。
• 静态站点生成（docmd build）与任何静态主机兼容（Vercel、Netlify、Cloudflare Pages、S3 等）。
• 内置 SEO、Open Graph、站点地图、版本控制、i18n 和 OpenAPI 渲染。
• 可选插件支持 PWA、线程讨论、KaTeX 等。

核心功能（面向机器）

• AI 助手 – 通过 RAG 查询文档的聊天界面。
• MCP 服务器 – 通过 docmd mcp 运行的简单协议，允许外部编码代理搜索、读取和验证文档。
• llms.txt / llms-full.txt – 可直接粘贴用于 LLM 提示的上下文文件。
• OKF 包 – 可被下游 RAG 流水线消费的结构化知识包。
• 语义搜索 – 除经典关键词搜索外，支持可选的向量检索。

如何使用

1. 全局安装（npm i -g @docmd/core）或通过 npx/Docker 运行。
2. 指定一个 .md 文件夹：

   npx @docmd/core dev   # 开发服务器
   npx @docmd/core build # 静态输出
   

3. 使用 docmd add <plugin> 添加插件（例如 pwa、threads）。
4. 用于 AI 集成时，安装 ai 核心插件（已包含），并配置云中继或自己的 LLM 端点。

可扩展性

• 插件系统：核心插件覆盖大多数需求；可从 npm 添加或本地构建可选插件。
• 程序化 API：import { build } from '@docmd/core' 可让 CI 流水线调用编译器。
• 配置可选；简单的 docmd.config.json 可设置标题、站点 URL、源/输出目录等。

社区与许可

• 核心和插件采用 MIT 许可证 – 可自由使用、修改和自托管。
• GitHub Discussions 中活跃的社区、公开路线图和赞助选项。
• 文档、迁移指南（从 Docusaurus、VitePress、MkDocs、Starlight）、实时编辑器均托管于 docmd.io。

总结 docmd 是一款开发者友好的工具，连接传统文档站点与 AI 增强工作流的新需求，让您从同一 Markdown 源中同时服务读者和 LLM。