Getting Started

Create and publish your first documentation site with Scalar Docs in minutes. Write guides in Markdown or MDX, add API documents for interactive API references, and deploy from GitHub, the CLI, or the web editor.

Create docs in three steps

Start a project

Create a Docs project from the dashboard, the Starter Kit, or any folder that contains a scalar.config.json file.

npx @scalar/cli project preview

Add guides and APIs

Write guides in Markdown or MDX, then add API documents for interactive API references.

{
  "navigation": {
    "routes": {
      "/getting-started": {
        "type": "page",
        "filepath": "docs/getting-started.md"
      }
    }
  }
}

Preview, publish, and sync

Use preview deployments for review, publish from the CLI, or connect GitHub Actions for automatic deployments.

npx @scalar/cli project publish

Write anywhere

Source	Description
GitHub	Keep content and API documents in your repository. Use preview deployments, automatic deployment, GitHub Actions, and scalar.config.json.
Any folder or CLI	Work from any folder or repository without granting repository access. Publish with `npx @scalar/cli project publish`.
Web editor	Edit and store docs at docs.scalar.com. No Git required.

Next steps

Scaffold a project with the Starter Kit
Configure your site with scalar.config.json
Structure your sidebar with Navigation
Deploy automatically with GitHub Actions

Just need an API reference? Use the API Reference. It is open source, free, and has integrations for REST API frameworks.

Scalar Docs

Privacy

The API company.