为人类和机器构建的
文档。
开源文档编译器。一份 Markdown 源文件,一条命令 – 同时生成网站、搜索、AI 上下文、Agent 协议和知识格式。全部一起。
$ npx @docmd/core dev # Initialising docmd compiler in /docs... ✓ Discovered 16 Markdown source files ✓ Generated static HTML + client-side vector search index ✓ Exported llms.txt, llms-full.txt & OKF graph bundles ✓ Built production documentation in 240ms – Lighthouse 100/100 → Dev server running at http://localhost:3000
开箱即用,无需配置。
内置搜索、SEO、主题和 AI 工具。按需开启所需功能。
编写 Markdown,获取网站
将 docmd 指向任意 Markdown 文件夹。它能瞬间构建出包含导航、热重载且无需配置的完整文档网站。
✓ Generated 12 pages in 340ms (Lighthouse 100)
原生 AI Agent 支持
通过内置 MCP 服务和自动生成的上下文文件,为 Claude、Cursor 和 Windsurf 等 AI 编码助手公开文档。
内置搜索,零云端成本
在构建时编译为本地索引文件的语义和关键字搜索。完全在浏览器中运行,无需云 API,无需托管成本。
原生 MDX 与交互式 JSX
支持在 Markdown 中直接使用 JSX 组件(
变量系统与动态个性化
在构建时与客户端插值环境变量、Git 提交哈希、构建版本以及 API 密钥与用户令牌等响应式变量,零运行时开销。
纯 Markdown 构建丰富内容
更偏爱标准语法?无需任何 HTML 或复杂配置,即可轻松书写提示框、选项卡代码块、警告框、卡片和图表。
Native Markdown callouts & tabs!
:::
交互式代码演练场
在 Markdown 中直接嵌入可运行的 JavaScript 沙盒与实时 HTML 组件预览,支持即时控制台输出拦截。
<button class="btn">Run</button>
:::
10万+ 按需动态图标
通过 @docmd/plugin-iconify 引入 Material、Carbon、Lucide 等 100+ 图标集。构建期按需内联纯 SVG,零客户端打包体积。
模块化插件生态
每个插件均可开箱即用,无需配置。仅开启您所需的功能。
离线向量搜索
完全在浏览器中运行的语义与关键字搜索。
原生 MDX 与 JSX
交互式 JSX 组件与动态表达式,客户端零运行时开销。
AI 助手
以您的文档为上下文回答问题的 AI 助手。
OpenAPI & Swagger 文档
根据 OpenAPI 规范文件生成交互式 API 参考页面。
交互式演练场 (Playground)
可运行的 JavaScript 交互沙盒与实时 HTML 组件预览。
Mermaid 图表
根据 Markdown 直接生成流程图、顺序图和架构图。
Git 历史与协作编辑
页面在线编辑入口、贡献者元数据与最后更新时间戳。
SEO & Schema JSON-LD
Sitemap、Meta 标签和结构化数据,全面提升搜索引擎可见度。
动态站点地图
自动化 XML 站点地图,让搜索引擎蜘蛛实时索引。
隐私友好遥测
注重隐私的文档访问指标,支持 Google Analytics 4 集成。
AI 上下文生成器
为 AI 工具自动生成 llms.txt、llms-full.txt 和 SKILL.md。
开放知识格式 (OKF)
面向大模型 (LLM) 推理管线确定性解析的结构化知识包。
Iconify 动态图标
来自 100 多个开源图标集的 100,000+ 图标,按需内联为纯 SVG。
KaTeX 数学公式
使用轻量级 KaTeX 渲染 LaTeX 数学表达式。
PWA 与离线缓存
内置 Service Worker 与应用清单,带来极致流畅的离线访问体验。
协同讨论组件
页面行内批注、上下文讨论与读者即时反馈。
专为自主 AI 编程智能体打造。
通过开放机器可读标准,将您的文档无缝提供给 Claude、Cursor、Windsurf 及定制大模型。
原生 MCP 服务端
允许 Claude Desktop、Cursor 和 Windsurf 通过 stdio 或 SSE 直接搜索、检查并读取您的完整文档。
llms.txt 与 llms-full.txt
生成标准化的大模型提要,使任何语言模型单次请求即可获取完整文档,无需网页爬虫抓取。
智能体技能 (SKILL.md)
将可执行的命令行工作流、架构规范与代码模式封装为可被编程助手自动发现的技能文件。
开放知识库 (okf.yaml)
将文档编译为机器可读的本体标签、概念图与语义知识包,专为多智能体协同工作流优化。
通过免费的 docmd Cloud Relay 为文档增添 AI 助手能力
通过 GitHub 秒级接入。获得实时搜索分析、发现文档缺失空白,并安全转发 AI 助手查询。
- AI 助手安全代理 – 自带密钥 (BYOK) 路由至 100+ 大模型,绝不在浏览器暴露密钥。
- 文档洞察分析 – 发现热门搜索词、流量趋势与未覆盖的内容盲区。
- 免费且免运维 – 通过 GitHub 账号数秒内快速连接,零服务器维护负担。
公开构建。开发者自主掌控。
文档天然属于 Git,绝不应被困在专有 SaaS 的围墙花园之中。
“文档是项目的智力核心。它理应作为纯 Markdown 文件保存在您的 Git 代码库中——永久留存、版本受控、清晰可查且永久免费。docmd 永远 100% 遵循 MIT 许可协议,绝不设置任何付费功能门槛。”
数据自主主权
您的所有文档均以纯 Markdown 格式保存在 Git 仓库中。无专有数据库,无私有结构。若需迁移,您可完整干净地带走所有内容。
零供应商锁定
编译为标准静态 HTML。免费部署到任意静态云平台或 CDN。零月费、零运行时外部依赖,绝无隐性开销。
宽松 MIT 许可
个人使用、开源项目和商业落地均完全免费。由坚信文档基础设施应当对所有人开放的工程师倾力打造。
与全球开源社区携手共建
由来自世界各地的独立开发者、代码贡献者以及赞助者共同驱动。
帮助维持 docmd 100% 免费与完全开源。所有赞助资金将直接用于编译器性能优化、智能体协议标准制定以及无服务器中继设施建设。
常见问题
关于 docmd 您需要了解的一切。
什么是 docmd?
docmd 与 Docusaurus、MkDocs 或 VitePress 有何不同?
我需要 React 或前端框架吗?
AI Agent 集成是如何工作的?
llms.txt 和 SKILL.md 文件。什么是 Agent Skills (SKILL.md)?如何安装?
npx docmd-skills [目标目录]