Installation

You can install @masumdev/markforge globally as a command-line tool or locally as a project dependency.

Global Installation (CLI)

Install globally to use the markforge command anywhere in your terminal:

npm

npm install -g @masumdev/markforge

bun

bun add -g @masumdev/markforge

pnpm

pnpm add -g @masumdev/markforge

yarn

yarn global add @masumdev/markforge

Verify your installation:

markforge --version
# Output: 0.10.0

---

Local Installation (Project / Monorepo)

Install as a development dependency in your workspace:

npm

npm install -D @masumdev/markforge

bun

bun add -d @masumdev/markforge

pnpm

pnpm add -D @masumdev/markforge

yarn

yarn add -D @masumdev/markforge

Add a script to your package.json:

{
  "scripts": {
    "build:docs": "markforge docs/spec.md --to docx,pdf,html -o dist/docs"
  }
}

---

PDF Requirements & Enterprise Sandboxing

PDF output is rendered via headless Chromium. MarkForge automatically detects the browser on your system:

Platform	Auto-detected browsers
Linux	google-chrome, chromium, chromium-browser, microsoft-edge, brave-browser
macOS	Google Chrome, Chromium, Microsoft Edge, Brave Browser
Windows	Microsoft Edge (native Windows 10/11 browser), Google Chrome, Brave Browser

Tip

Enterprise & Windows Environments: MarkForge runs headless Chromium with strict sandboxing flags (--disable-sync, --no-first-run, --no-default-browser-check, isolated temporary --user-data-dir, and zero external network font requests). On Windows, Microsoft Edge is automatically detected and prioritized.

Custom Browser Path & Configuration Fallback

If your browser is installed in a non-standard location, you can configure it explicitly via markforge.config.ts, CLI flag, or environment variables:

1. In markforge.config.ts:

   export default defineConfig({
     browserPath: "C:\\Program Files (x86)\\Microsoft\\Edge\\Application\\msedge.exe",
   });

2. Via CLI Flag:

   markforge doc.md --to pdf --browser-path "C:\Program Files (x86)\Microsoft\Edge\Application\msedge.exe"

3. Via Environment Variables:

   # Linux / macOS
   export CHROME_PATH="/usr/local/bin/chromium"
   
   # Windows (PowerShell)
   $env:MARKFORGE_BROWSER_PATH = "C:\Program Files (x86)\Microsoft\Edge\Application\msedge.exe"