Skip to content

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:

Terminal window
npm install -g @masumdev/markforge

Verify your installation:

Terminal window
markforge --version
# Output: 0.4.0

Local Installation (Project / Monorepo)

Install as a development dependency in your workspace:

Terminal window
npm install -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:

PlatformAuto-detected browsers
Linuxgoogle-chrome, chromium, chromium-browser, microsoft-edge, brave-browser
macOSGoogle Chrome, Chromium, Microsoft Edge, Brave Browser
WindowsMicrosoft Edge (native Windows 10/11 browser), Google Chrome, Brave Browser

Custom Browser Path

If your browser is installed in a non-standard location, set the CHROME_PATH environment variable:

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