Quickstart

1. Preview Your Docs

Run a local development server to see your changes in real-time:

npx @scalar/cli project preview

This starts a live preview at http://localhost:7970 where every edit you make is instantly visible.

Make it yours with themes, custom CSS, and MDX. Configure your documentation structure, navigation, and styling through scalar.config.json.

First, authenticate with your Scalar account:

npx @scalar/cli auth login

Then publish your documentation:

npx @scalar/cli project publish --slug [dashboard-project-slug]

Your site will be available at <your-slug>.apidocumentation.com.

Check whether your scalar.config.json is valid:

npx @scalar/cli project check-config

We're here to help: