一个脚手架工具,把可编辑的 Astro 文档站点生成到你的仓库中,内置面向智能体的 Markdown 与 llms.txt 输出。
- Star
- 2,528
- Fork
- 144
- 未关闭 Issue
- 2
- 最近提交
- 3天前
这是什么?
docmd 是一款基于 Node.js 的文档编译器。将包含 Markdown 文件的文件夹交给它,即可生成带导航的静态网站,导航根据文件结构自动生成,启动时无需配置文件或 frontmatter。一次构建还会同时生成离线搜索索引、sitemap、SEO 与 Open Graph 元数据以及 robots.txt。
同一份源文件还能输出面向机器的内容:生成 llms.txt 和 llms-full.txt,输出用于 RAG 系统的 Open Knowledge Format 知识包,并提供 MCP 服务,让编码智能体可以搜索、读取和校验文档。可选的 AI 助手插件支持基于文档的问答,可接入自有模型服务,也可通过托管的 Cloud Relay 使用。
项目支持多语言、多版本文档、monorepo 工作区、OpenAPI 3.x 渲染、Mermaid 图表和插件系统。内置 migrate 命令,可从 Docusaurus、VitePress、MkDocs 或 Starlight 迁移。生成的站点可部署到任意静态托管平台。
核心功能
- 01根据文件结构自动生成导航的静态文档站点
- 02离线全文搜索、sitemap、规范 URL 与 Open Graph 元数据
- 03输出 llms.txt、llms-full.txt 与 Open Knowledge Format 知识包
- 04提供 MCP 服务,供编码智能体搜索、读取和校验文档
- 05支持多语言、多版本和 monorepo 工作区
- 06支持 OpenAPI 3.x 渲染与 Mermaid 图表
适用场景
- 将已有的 Markdown 文件夹直接发布为项目文档站点,无需额外配置
- 为 LLM 和编码智能体提供结构化的文档上下文
- 迁移现有的 Docusaurus、VitePress 或 MkDocs 站点
- 在任意静态托管服务上发布多语言 API 文档
快速上手
- 1
将 docmd 指向 Markdown 文件夹并启动开发服务器
npx @docmd/core dev - 2
构建用于部署的静态站点
npx @docmd/core build
使用前须知
- 需要 Node.js 20 或更高版本。
- AI 助手等可选功能需要你自己的 AI 服务商密钥或 Cloud Relay,模型用量可能另行收费。
标签
常见问题
- docmd 是什么?
- 一款 Markdown 文档编译器,将同一份源文件输出为静态文档站点、离线搜索、llms.txt 和 AI 上下文。 docmd 是一款基于 Node.js 的文档编译器。将包含 Markdown 文件的文件夹交给它,即可生成带导航的静态网站,导航根据文件结构自动生成,启动时无需配置文件或 frontmatter。一次构建还会同时生成离线搜索索引、sitemap、SEO 与 Open Graph 元数据以及 robots.txt。
- docmd 可以免费使用吗?用的什么许可证?
- docmd 以 MIT 许可证开源。用于商业产品前,请先确认许可证条款。
- docmd 还在维护吗?
- 活跃维护中。docmd 最近一次提交是在 2026年10月16日。
- docmd 适合用来做什么?
- 将已有的 Markdown 文件夹直接发布为项目文档站点,无需额外配置 为 LLM 和编码智能体提供结构化的文档上下文 迁移现有的 Docusaurus、VitePress 或 MkDocs 站点 在任意静态托管服务上发布多语言 API 文档
- docmd 怎么安装和运行?
- 将 docmd 指向 Markdown 文件夹并启动开发服务器: npx @docmd/core dev 构建用于部署的静态站点: npx @docmd/core build
- 在哪里获取 docmd?
- 源代码和安装说明在 GitHub 上:https://github.com/docmd-io/docmd
概要由 AI 根据项目 README 生成;GitHub 数据每日更新。
相关项目
由 Material for MkDocs 团队打造、基于 Rust 的现代静态站点生成器,用于 Markdown 文档站点。
基于 Nuxt 的文档框架,用 Markdown 文件和 Vue 组件构建文档站点。
将 Markdown 渲染为兼容主流邮件客户端的响应式 HTML,并生成纯文本版本。
根据 OpenAPI 规范自动生成多种语言的 API 客户端 SDK、服务端桩代码和文档。
可自托管的公平代码工作流自动化平台,用于构建 AI 智能体与工作流,支持 1500 多种集成。