Choose the installation method that fits your workflow.

Run instantly with npx

npx @docmd/core dev

No installation needed. Runs docmd directly inside any folder with Markdown files.

# Build a production-ready static site
npx @docmd/core build
npm
pnpm
yarn
bun
npm install -D @docmd/core
npx docmd init
npx docmd 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

This pins the version across your team and CI/CD pipeline.

After local install

Once @docmd/core is a project dependency, use npx docmd instead of npx @docmd/core for all commands.

Install globally

npm
pnpm
yarn
bun
npm install -g @docmd/core

pnpm add -g @docmd/core

yarn global add @docmd/core

bun add -g @docmd/core

# Use the 'docmd' command anywhere
docmd dev
docmd build

Browser-only integration

Library use only

This method embeds the docmd rendering engine into another web application. It is not the standard way to build documentation sites.

<!-- Core Styles -->
<link rel="stylesheet" href="https://unpkg.com/@docmd/ui/assets/css/docmd-main.css">

<!-- Processing Engine -->
<script src="https://unpkg.com/@docmd/live/dist/docmd-live.js"></script>

See the Browser API guide for integration details.

Troubleshooting

Permission denied (EACCES)

If you encounter EACCES errors during global installation on macOS or Linux, switch to a Node version manager like nvm or fnm instead of using sudo.

PowerShell script execution (Windows)

If PowerShell blocks script execution, run as Administrator:
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser

previous Quick Start next Project Structure