安装
选择适合您工作流的安装方式。本地构建需要 Node.js 18 或更高版本。
1. 本地安装（推荐）
在本地运行 docmd 可让文档配置与源代码一同纳入版本管理。
npm
pnpm
yarn
Bun
Docker
# 作为开发依赖安装
npm install -D @docmd/core
# 初始化新项目
npx docmd init
# 作为开发依赖安装
pnpm add -D @docmd/core
# 初始化新项目
pnpm dlx docmd init
# 作为开发依赖安装
yarn add -D @docmd/core
# 初始化新项目
yarn dlx docmd init
# 作为开发依赖安装
bun add -D @docmd/core
# 初始化新项目
bunx docmd init
# 拉取官方多架构镜像
docker pull ghcr.io/docmd-io/docmd:latest
# 从本地 docs/ 构建文档到 site/
docker run -v $(pwd)/docs:/docs -v $(pwd)/site:/site ghcr.io/docmd-io/docmd:latest build
Docker Compose 与 Kubernetes 配置请参阅 Docker 部署指南。
<img width=“500” class=“with-border” src=“/assets/previews/terminal-npx-init.webp”>
脚本简写
本地安装完成后，可使用 npx docmd dev 启动实时预览服务器，或直接将脚本添加到 package.json。
2. 全局安装
将软件包全局安装，以便在系统任意位置创建或预览站点，无需创建本地项目。
npm
pnpm
yarn
Bun
npm install -g @docmd/core
pnpm add -g @docmd/core
yarn global add @docmd/core
bun add -g @docmd/core
安装后，docmd 命令在任意位置可用：
docmd dev # 在本地启动开发服务器
docmd build # 构建静态输出
3. 仅浏览器集成
通过 CDN 直接将引擎嵌入现有的 Web 应用。
专用库集成
这种方式绕过 CLI，并在访客的浏览器中加载解析引擎。适用于动态门户，而非静态 SEO 网站。
在您的 HTML 中添加样式表与 JavaScript 引擎。
<!-- 核心样式表 -->
<link rel="stylesheet" href="https://unpkg.com/@docmd/ui/assets/css/docmd-main.css">
<!-- 同构渲染引擎 -->
<script src="https://unpkg.com/@docmd/live/public/docmd-live.js"></script>
完整集成细节请参阅 浏览器 API 指南。
4. 故障排查
权限被拒（EACCES 错误）
在 macOS 或 Linux 上进行全局安装时，请勿使用 sudo。可通过 nvm 或 fnm 等 Node.js 版本管理器解决权限冲突。
PowerShell 执行策略（Windows）
如果 Windows 阻止执行脚本，请以管理员身份打开 PowerShell 并启用当前用户的脚本执行权限。
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser