📘 写完 Markdown 直接变成文档站,还自带能问答的 AI
GitHub 上 2.4K stars
给自己的项目搭个文档站,常见的路是装一套静态站点生成器,然后开始配:导航要写一遍,搜索要接第三方服务,多语言要改结构,出个新版本又得单独开一份。文档还没写几行,配置文件先几百行了。
docmd 主打零配置:把 Markdown 放好,它按文件结构自动生成导航,构建出来是可以直接丢到任何静态托管上的单页应用。搜索是内置的离线全文搜索,不依赖外部服务;站点地图、规范网址和 Open Graph 元数据也都自动带上,SEO 那块不用另外折腾。多语言构建、多版本文档、工作区和主题定制都是内置能力。
AI 那部分做得比较超前:它能基于你的文档内容跑一个 RAG 助手,读者直接问问题;同时提供 MCP 服务器,让 AI 编程工具能读你的文档;还会在构建时生成 AI 上下文文件。
核心包是
@docmd/core,要求 Node.js 18 以上,提供 CommonJS 和 ESM 两种编程接口,也有官方 Docker 镜像。MIT 协议。
文档写给人看,现在也得写给 Agent 看。
GitHub: