快速开始
在包含 Markdown 文件的任何目录中运行 docmd。无需配置文件、无需初始化开销、也不需要框架经验。
1. 启动开发服务器
npm
pnpm
yarn
Bun
npx @docmd/core dev
pnpm dlx @docmd/core dev
yarn dlx @docmd/core dev
bunx @docmd/core dev
这会打开 http://localhost:3000。你的文档现已实时运行。
自动端口切换
如果端口 3000 当前已被占用，docmd 会自动检测并绑定到下一个可用端口（例如 3001）。
2. 自动功能解析
引擎会自动配置所有核心功能：
- 目录检测: 扫描项目根目录下的
docs/、src/docs/、documentation/、content/或任何.md文件。 - 导航结构构建: 直接从你的目录层级构建嵌套的侧边栏导航树。
- 标题解析: 自动提取第一个
H1标题标签作为页面标题。 - 搜索索引: 即时生成客户端全文搜索索引。
- 智能缓存: 保存文件时自动触发低于 200ms 的增量构建。
无需 docmd.config.json。后续可以随时添加配置文件来自定义布局、插件或版本控制设置。
3. 构建生产产物
将你的 Markdown 文件编译为优化的静态生产网站。
npm
pnpm
yarn
Bun
npx @docmd/core build
pnpm dlx @docmd/core build
yarn dlx @docmd/core build
bunx @docmd/core build
编译器会将静态站点输出到 ./site/。可将此静态产物托管在任何地方，如 GitHub Pages、Vercel、Netlify 或任何静态 HTTP 主机上。