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 數學公式等功能。

相關

  • 專案
  • 專案
  • 專案
  • 專案
  • 專案