快速启动
在 Markdown 文件文件夹中的点名 :
npx @docmd/core dev
打开 http://localhost:3000。 。 。 .
就是这样。 导航由您的文件结构生成 。 不需要配置文件、前题或框架 .
准备好部署时:
npx @docmd/core build
docmd生成一个静态站点,可以被部署到Vercel, Cloudflare Pages,Netlify,GitHub Pages,S3,NGINX,Caddy或任何其他静态主机.
需要节点.js 20+.
全球安装和多克
全球安装 :
npm install -g @docmd/core
# or
pnpm add -g @docmd/core
然后说:
docmd dev
docmd build
或与多克同跑:
docker run -p 3000:3000 ghcr.io/docmd-io/docmd:latest
将 Docker 图像固定为可复制生产建筑的特定释放 .
一个来源。 每个输出.
docmd是一个开源文档编译器.
Docmd 将同一源码编译成供读者、搜索引擎、LLMs、编码代理和知识系统使用的产出,而不是仅作为网站的输入.
Markdown
│
▼
docmd
│
├── → Static documentation site
├── → Offline search index
├── → llms.txt / llms-full.txt
├── → Open Knowledge Format (OKF)
├── → Sitemap + SEO metadata
├── → robots.txt + Open Graph
├── → MCP interface for AI agents
└── → AI Assistant context
一出源树. 一条管道 没有单独的文档和AI知识堆栈需要维护.
为什么是医生?
越来越多的文件读者不止一个.
人们需要一个快速,通航的网站. 搜索引擎需要结构化元数据. 法学硕士课程需要干净的背景。 编码代理需要工具和协议. RAG系统需要结构化的知识.
docmd在将Markdown保留在中心的同时将这些东西一起建造.
参见与 Docusaurus、Mintlify和其他文档工具 –
特征
零配置, 即时启动
任何Markdown文件夹的点数和它运行。 导航是自动从您的文件结构生成的——没有锅炉板,前置物,或构建启动所需的管道.
轻而易举,无所不在
docmd生成静态的HTML,最小的香草JavaScript和快的SPA风格导航. 离线全文搜索,站点地图,Canonic URL,Open Graph元数据等基本内容被构建到输出中.
AI 代理准备( A)
docmd将机器可读文档作为构建的一部分,而不是单独的出版工作流程.
- 大赦国际助理 ——基于文档的RAG能动聊天
- MCP 服务器 ——让兼容的编码代理搜索、读取和验证您的文件
llms.txt编号 :llms-full.txt——完整的LLM可读文件背景- 开放知识格式( OKF) 用于AI和RAG系统的结构化知识包
- 代理技能 ——LLMS和编码代理的可再用指令
- 复制为 Markdown / 复制上下文 ——直接从浏览器中提取干净的上下文
- 语义搜索 ——可选向量检索与内置关键字搜索
建为规模
- 以地方意识搜索和产出实现国际化
- 多个文件发布版本
- 单重机和多项目设置的工作空间
- API 文档的 OpenAPI 3.x 渲染
- 内建模板,自定义 CSS/JavaScript,以及轻/暗模式
AI 助手和云中继器
docmd包括一个基于你文档的RAG授权AI助理.
您可以连接到自己的后端或本地的AI提供商. 如果你的文件是作为静态站点部署的, docmd 云中继器 提供主机桥.
Your documentation
│
▼
@docmd/plugin-ai
│
▼
docmd Cloud Relay
│
▼
Your AI provider
Cloud Relay安全地向您选择的提供者发送AI请求,因此提供者证书不需要被运至浏览器,也无需操作AI后端.
Cloud Relay可自由使用自有的AI提供者密钥.
- 带上自己的供应商和模特儿
- 保留客户端的提供者证书
- 静态托管工程
- 没有用于部署或维护的AI后端
- 使用能见度和读者问题见解
- 从一个账户连接多个文档项目
设置 Cloud 中继 二. 支助 AI 助理文件 −
云中道自在. 您所选择的 AI 提供者可单独收取模型使用费.
国 际
docmd dev # Start the local development server
docmd build # Build for production
docmd live # Start the browser-based Live Editor
docmd init # Create a configuration file
docmd doctor # Check configuration and plugin status
docmd validate # Check internal documentation links
docmd migrate # Migrate from Docusaurus, VitePress, MkDocs, or Starlight
docmd deploy # Generate deployment configuration
docmd mcp # Run the MCP server over stdio
docmd add <name> # Install a plugin or template
docmd stop # Stop running docmd development servers
见完整 CLI 命令 •
插件
docmd是围绕一个插件系统构建的. 有核心的通用文献能力船,同时在需要时可以安装可选插件.
| 插件 | 状态 | 说明 |
|---|---|---|
ai | 核心 | RAG 有本地供应商BYOK和Cloud Relay的AI助理 |
search | 核心 | 带有可选语义搜索的离线关键词搜索 |
seo | 核心 | SEO 和 开放式图元数据 |
sitemap | 核心 | 生成 sitemap.xml |
git | 核心 | Git 历史和最近更新的元数据 |
analytics | 核心 | 轻量级分析一体化 |
llms | 核心 | 生成 llms.txt 财务报告和审定财务报表 llms-full.txt |
okf | 核心 | 打开知识格式捆绑 |
mermaid | 核心 | 美人鱼图渲染 |
openapi | 核心 | OpenAPI 3.x 文档渲染器 |
pwa | 可选 | 进步的Web App和离线导航 |
threads | 可选 | 内部文件讨论 (由@svallory) (中文(简体) ) |
math | 可选 | KaTeX / LaTeX 渲染 |
安装可选插件 :
docmd add <plugin-name>
构建自己的 : 插件开发指南
配置
配置是可选的 .
添加 docmd.config.json, (中文(简体) ), docmd.config.ts,或 docmd.config.js 当您需要更多控制时, 在您的工程根中 :
{
"title": "My Project",
"url": "https://docs.myproject.com",
"src": "./docs",
"out": "./dist"
}
当需要动态值时,可以使用TypeScript和JavaScript配置.
程序化 API
使用来自Node.js脚本的docmd,CI管道,或自定义构建系统.
import { build } from '@docmd/core';
// Build documentation programmatically.
await build('./docmd.config.json', { isDev: false });
支持共同JS和无害环境管理.
移徙
现有文件不需要从零开始.
docmd migrate
移徙工具可用于辅助文件框架,包括Docuraus、VitePress、MkDocs和Starlight.
开源
你的文献是你们项目的知识核心 它属于您 Git 仓库中的平版Markdown 文件—— 便携式, 版本控制和可审计 .
Docmd编译器和官方核心插件是MIT许可的,并将保持自由使用,没有付费墙编译器的功能.
生成的文件可以在任何地方托管,不需要docmd托管的基础设施.
社区
- 文档 → 文件.doc.docmd.io
- 问题和想法 → GitHub 讨论
- 错误特性请求( T) → GitHub 问题
- 捐款 → 捐款额
- 路线图 → GitHub 讨论
支持文档d
如果 docmd对您有用:
- 给存储器一个QQ
- 和某个建筑文件分享吧
- 打开问题、 提供修正或构建插件
- GitHub 赞助开发
许可证
MIT许可证。 见 自由主义 详细情况.