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

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.