Docs Starter Kit
Project structure#
The starter includes a minimal layout: a docs/ folder (with api-reference/ for API documents and content/ for free-form content) and a scalar.config.json file at the repository root.
1. Preview your docs#
Run a local development server to see your changes in real-time:
npx @scalar/cli project previewThis starts a live preview at http://localhost:7970 where every edit you make is instantly visible.
Read more about Preview deployments and the CLI.
2. Include API documents#
Drop your API documents into docs/api-reference/, and add them to scalar.config.json to have them automatically become interactive API references.
The starter kit includes an example OpenAPI document to show you how it works.
Read more about scalar.config.json and Getting started with Docs.
3. Customize everything#
Make it yours with themes, custom CSS, and MDX. Configure your documentation structure, navigation, and styling through scalar.config.json.
For appearance options, see Themes.
4. Publish your docs#
First, authenticate with your Scalar account:
npx @scalar/cli auth loginThen publish your documentation:
npx @scalar/cli project publishYour site will be available at <your-slug>.apidocumentation.com.
Stuck?#
Check whether your scalar.config.json is valid:
npx @scalar/cli project check-configFor full options, see the Configuration reference.
We are here to help: