docmd

一份 Markdown，同时生成网站、搜索和 AI 上下文

开源 unknown 办公效率

访问官网 ↗ GitHub ↗ 文档 ↗

GitHub 星标 ★ 2514

维护状态活跃

是否开源是

定价模式 unknown

项目预览

项目数据

分类办公效率

开发团队docmd-io

所属国家

官网地址https://docmd.io

GitHubhttps://github.com/docmd-io/docmd

定价模式unknown

价格说明定价信息待确认

访问状态

是否开源是

开源协议MIT

主要语言TypeScript

技术栈/模型ai-skills,api,context-api,docker,docmd,documentation,i18n,javascript,markdown,mcp,nodejs,openapi,plugins,pwa,semantic-search,seo,static-site-generator,themes,typescript,version-control

GitHub 星标★ 2514

30天Star增速

HF 下载量

上线时间2025-05-08 00:00:00

代码更新—

仓库体积—

本站数据更新—

维护状态活跃

中文支持

访问方式

移动端支持

综合评分

收录时间2026-10-11

浏览次数0

项目介绍

docmd 是一个用 TypeScript 编写的文档编译器，目标是把单一 Markdown 源文件同时输出为网站、站内搜索、AI 上下文和多种知识格式。它解决的是文档团队常见的重复劳动问题：过去写一份文档，要分别维护静态站点、搜索索引、给大模型用的上下文片段，甚至 OpenAPI 说明，彼此容易不同步。docmd 把这些环节收进一条编译流水线，支持 i18n 多语言、插件扩展、PWA 离线访问，并提供 API、MCP、Context API 等面向 AI 与自动化的接口。它适合希望一次编写、多端消费的开发者文档、产品手册和知识库场景，让人类读者和 AI 代理都能拿到结构一致的内容。

Star 增长趋势

本站每日记录该项目 GitHub 星标变化，观测越久曲线越完整

正在加载星标数据…

技术标签

使用教程

—

难度：入门约 10 分钟部署方式：命令行工具 6 步

环境要求

Node.js 20 或更高版本
一个存放 Markdown 文件的目录
可联网以通过 npx 拉取 @docmd/core 包
可选：全局安装需要 npm 全局写权限

安装与启动步骤

1准备 Markdown 目录

把要编译的 Markdown 文件放进任意文件夹，导航会根据文件结构自动生成，无需 frontmatter 或框架。
2启动开发预览

在项目根目录运行，docmd 会启动本地开发服务器，实时预览文档站点效果。
```
npx @docmd/core dev
```
3浏览器访问预览

打开本地地址查看生成的站点与自动导航，确认内容与目录结构符合预期。
4构建静态站点

内容确认无误后执行构建，docmd 会产出可部署的静态站点文件。
```
npx @docmd/core build
```
5全局安装(可选)

如果不想每次用 npx，可以全局安装 @docmd/core，之后直接调用命令。
```
npm install -g @docmd/core
```
6部署静态产物

把构建出的静态文件夹上传到 Vercel、Cloudflare Pages、Netlify、GitHub Pages、S3、NGINX、Caddy 等静态托管。

关键配置

配置项	必填	说明	示例
`title`	否	站点标题，显示在生成的文档页面中。	`My Project`
`url`	否	站点正式访问地址，用于生成绝对链接。	`https://docs.myproject.com`
`src`	否	Markdown 源文件所在目录。	`./docs`
`out`	否	构建产物输出目录。	`./dist`

如何确认成功

运行 npx @docmd/core dev 后浏览器打开 http://localhost:3000，能看到按文件结构自动生成的导航和文档页面即成功。

常见问题

Q：必须写配置文件吗？

A：不需要。配置完全可选，只有在需要自定义标题、URL、源目录和输出目录时，才在项目根目录添加 docmd.config.json、docmd.config.ts 或 docmd.config.js。

Q：构建产物能部署到哪里？

A：docmd 生成的是静态站点，可部署到 Vercel、Cloudflare Pages、Netlify、GitHub Pages、S3、NGINX、Caddy 或任意其他静态托管服务。

Q：需要什么 Node 版本？

A：需要 Node.js 20 或更高版本，版本过低会导致安装或运行失败。

Q：配置文件支持哪几种格式？

A：支持 docmd.config.json、docmd.config.ts 和 docmd.config.js，需要动态取值时可使用 TypeScript 或 JavaScript 配置。

注意事项

导航由 Markdown 文件结构自动生成，不需要手动维护菜单。
dev 与 build 都通过 npx 调用 @docmd/core，无需先克隆仓库。
官方配置参考文档位于 https://docs.docmd.io/configuration/overview。

核心亮点

单一 Markdown 源同时产出网站、搜索索引与 AI 上下文，减少多套内容维护的同步成本
内置 MCP、Context API、OpenAPI 等接口，方便把文档直接接入 AI 代理和自动化流程
支持 i18n、插件、PWA 与 Docker，部署和扩展方式贴近现代前端工程习惯

不足之处

项目仍处成长阶段，插件生态和第三方集成数量有限
面向 AI 的上下文格式与 MCP 等能力较新，长期兼容性和最佳实践待观察

适用场景

技术团队维护对外开发者文档，需要同时提供网页、搜索和 AI 问答上下文
产品团队把一份 Markdown 手册编译成多语言站点并支持离线 PWA 访问
AI 应用开发者通过 MCP 或 Context API 把项目文档接入自有代理和检索流程

替代项目

Docusaurus、MkDocs、VitePress

上一篇：GithubStarsManager

下一篇：没有了！