docmd-io/docmd

Documentation compiler for humans and machines. One Markdown source, one command — website, search, AI context, and knowledge formats together.

解决的问题

docmd 是一个将 Markdown 文件转换为生产就绪的静态网站的文档生成器。它消除了对复杂配置、样板代码和重型 JavaScript 压力包的需求,为人类读者和 AI 代理都提供了快速、SEO 优化的体验。

工作原理

它作为静态网站生成器(SSG)运行,能够自动从 Markdown 文件夹的文件结构中生成导航。可以通过 npx 无需安装直接运行,也可以作为全局 CLI 工具使用。系统包含插件架构,可扩展功能,例如添加搜索、SEO 和 AI 能力。

适用人群

希望快速发布文档而无需花费时间在配置或构建流水线上的开发者,以及希望集成 AI 驱动的搜索和代理就绪文档的开发者。

主要亮点

  • 零配置:导航和网站结构可自动从文件夹结构中推导。
  • AI 原生:内置 RAG 驱动的 AI 助手、AI 代理用的 MCP 服务器,以及自动创建 llms.txt 上下文文件。
  • 高性能:极小的 JavaScript 压力包(约 18 KB)和即时 SPA 导航。
  • 企业就绪:原生支持版本控制、国际化(i18n)和多项目工作区。
  • 可扩展:强大的插件系统,支持添加 Mermaid 图表、OpenAPI 渲染和 KaTeX 数学公式等功能。

相关

  • 项目
  • 项目
  • 项目
  • 项目
  • 项目