Scalar Starter Kit

Quickstart

Welcome to the Scalar Docs Starter Kit — a template for deploying beautiful documentation from a GitHub repository. Every page is MDX by default: mix Markdown with JSX expressions (this page rendered in 2026) and drop in components anywhere. Fork it, edit the files under docs/content/, and make it yours.

Explore

  • Layouts: hide the sidebar, move search, or build a fully custom landing page
  • Components: Callout, Button, Tabs, and every other component you can drop into MDX
  • API References: add OpenAPI documents from a file, the Scalar Registry, or a URL

Configure your site

In the Scalar dashboard, open your docs project and select Settings in the left sidebar:

  • Site: change the site title, description, and domain.
  • Appearance: choose a theme, light or dark mode, and logos.

If you are editing this repository directly, make these changes in scalar.config.json.

Preview locally 

npx @scalar/cli@latest project preview

Starts a dev server at http://localhost:7971 with live reload.

Publish 

npx @scalar/cli@latest auth login
npx @scalar/cli@latest project publish

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

Next
API References