安装
根据你的工作流选择合适的安装方式。
即时运行
npm
Bun
npx @docmd/core dev
bunx @docmd/core dev
无需安装。可在任意包含 Markdown 文件的目录中直接运行 docmd。
npm
Bun
# 构建生产版本静态网站
npx @docmd/core build
# 构建生产版本静态网站
bunx @docmd/core build
安装为项目依赖（推荐）
npm
pnpm
yarn
Bun
npm install -D @docmd/core
npx @docmd/core init
npx @docmd/core dev
pnpm add -D @docmd/core
pnpm dlx docmd init
pnpm dlx docmd dev
yarn add -D @docmd/core
yarn docmd init
yarn docmd dev
bun add -D @docmd/core
bunx docmd init
bunx docmd dev
这种方式可以锁定版本，方便团队和 CI/CD 流水线保持一致。
本地安装后
将 @docmd/core 安装为项目依赖后，所有命令改用 npx @docmd/core 替代 npx @docmd/core。
全局安装
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
仅浏览器集成
仅限库集成模式
此方式将 docmd 渲染引擎嵌入到其他 Web 应用中，不适用于标准文档网站的构建方式。
<!-- 核心样式 -->
<link rel="stylesheet" href="https://unpkg.com/@docmd/ui/assets/css/docmd-main.css">
<!-- 处理引擎 -->
<script src="https://unpkg.com/@docmd/live/dist/docmd-live.js"></script>
具体采用方式请参阅 浏览器 API 指南。
常见问题
PowerShell 脚本执行策略（Windows）
如果 PowerShell 阻止脚本执行，请以管理员身份运行：
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser