Deployment

Ship your docs as static HTML or a Node server — markline init scaffolds the configs.

Static hosting

markline export   # → ./out

Upload out/ to any static host — a CDN, GitHub Pages, Netlify, or S3.

The scaffolded .github/workflows/deploy.yml exports and deploys on push to main, building under /<repo> for project sites.

On static hosts the API playground runs in direct-fetch mode. Set api.playground.proxy to "never".

markline build && markline start

This enables the playground's server-side proxy for APIs without CORS. The scaffolded Dockerfile builds and serves the site:

docker build -t my-docs . && docker run -p 3000:3000 my-docs

Serving under a path prefix (e.g. a GitHub Pages project site)? Set the base path so assets and search resolve correctly:

MARKLINE_BASE_PATH=/my-repo markline export