documentation/guides/docs/getting-started.md
Include interactive API references, for a single API or for hundreds of APIs. All based on the OpenAPI standard. And the best part: Your documentation stays in sync with your actual API.
[!TIP] Just need an API Reference and that's all? Use the API Reference. It is open-source, free, and has integrations for all REST API frameworks.
Put your content where you want: in your repository, any folder, or the Scalar Editor.
| Source | Description |
|---|---|
| GitHub (recommended) | Content and OpenAPI in your repository. CI/CD: preview deployments, automatic deployment, GitHub Actions, scalar.config.json. |
| Any folder / CLI | No repository access needed. Content in any folder or repository, run npx @scalar/cli project publish. |
| Web editor | Edit and store docs at docs.scalar.com. No Git required. |
| Free | Pro | Enterprise | |
|---|---|---|---|
| Subdomains, API references, themes, custom HTML/CSS/JS, email domain access | ✓ | ✓ | ✓ |
| Custom domains, Guides, versions, Git Sync, Markdown + MDX, landing pages, full developer portal | ✓ | ✓ | |
| SSO/SAML, RBAC, priority support, dedicated Slack/Teams | ✓ |
See the full comparison for Docs and the other Scalar products.
<div class="feature"> <div class="cta flex flex-col gap-3 small-test"> <scalar-heading level="2" class="text-balance" slug="what-are-you-waiting-for">What are you waiting for?</scalar-heading> <p> We're committed to enabling developers and companies to practice the highest of API industry standards. </p> <div class="flex gap-2 mb-11"> <a class="t-editor__button" href="https://dashboard.scalar.com/register">Get Started</a> <a class="t-editor__button" href="https://scalar.cal.com/scalar/chat-with-scalar" target="_blank">Book a Demo</a> </div> <a class="expander-hover-link" href="https://discord.gg/scalar" target="_blank" aria-label="Join Scalar community on Discord">Community →</a> <a class="expander-hover-link" href="https://github.com/scalar/scalar" target="_blank" aria-label="View Scalar on GitHub">GitHub →</a> <a class="expander-hover-link" href="mailto:[email protected]" target="_blank" aria-label="Contact Scalar support">Contact Us →</a> </div> </div> </div> <div class="resources-cta sticky"> <div class="resources-cta-container"> <p class="mt-3 mb-1 pl-2"> <b class="font-medium">Additional Reading</b> </p> <p> <a class="flex items-center gap-1.5 font-medium text-c-2 hover:bg-b-2 rounded px-2 p-1" href="/products/docs/configuration/scalar.config.json"><scalar-icon src="phosphor/bold/git-branch"></scalar-icon>Configuration</a> </p> <p> <a class="flex items-center gap-1.5 font-medium text-c-2 hover:bg-b-2 rounded px-2 p-1" href="/products/docs/deployment/automatic-deployment"><scalar-icon src="phosphor/bold/arrow-square-out"></scalar-icon> Automatic Deployment</a> </p> <p> <a class="flex items-center gap-1.5 font-medium text-c-2 hover:bg-b-2 rounded px-2 p-1" href="/products/docs/deployment/preview-deployments"><scalar-icon src="phosphor/bold/code"></scalar-icon> Preview Deployments</a> </p> <p> <a class="flex items-center gap-1.5 font-medium text-c-2 hover:bg-b-2 rounded px-2 p-1" href="/products/docs/deployment/cli"><scalar-icon src="phosphor/bold/terminal"></scalar-icon> CLI</a> </p> <p> <a class="flex items-center gap-1.5 font-medium text-c-2 hover:bg-b-2 rounded px-2 p-1" href="/products/docs/configuration/starter-kit"><scalar-icon src="phosphor/bold/rocket-launch"></scalar-icon> Starter Kit</a> </p> <p> <a class="flex items-center gap-1.5 font-medium text-c-2 hover:bg-b-2 rounded px-2 p-1" href="/products/docs/configuration/themes"><scalar-icon src="phosphor/bold/palette"></scalar-icon> Themes</a> </p> <p> <a class="flex items-center gap-1.5 font-medium text-c-2 hover:bg-b-2 rounded px-2 p-1" href="/products/docs/configuration/private-docs"><scalar-icon src="phosphor/bold/users"></scalar-icon> Private Docs</a> </p> <p class="mt-3 mb-1 pl-2"> <b class="font-medium">Community</b> </p> <p> <a class="flex items-center gap-1.5 font-medium text-c-2 hover:bg-b-2 rounded px-2 p-1" href="https://discord.gg/scalar" target="_blank"><scalar-icon src="phosphor/bold/discord-logo"></scalar-icon> Discord</a> </p> <p> <a class="flex items-center gap-1.5 font-medium text-c-2 hover:bg-b-2 rounded px-2 p-1" href="https://twitter.com/scalar" target="_blank"><scalar-icon src="phosphor/bold/twitter-logo"></scalar-icon> Twitter</a> </p> <p> <a class="flex items-center gap-1.5 font-medium text-c-2 hover:bg-b-2 rounded px-2 p-1" href="https://github.com/scalar/scalar" target="_blank"><scalar-icon src="phosphor/bold/github-logo"></scalar-icon> GitHub</a> </p> </div> </div> </div> <div class="expander-container"> <div class="expander-hover"> <div class="expander-hover-preview"></div>
<div class="relative">
<div class="expander-hover-sticker">
<object class="sticker-clip-client" width="156" height="110"
data="https://api.scalar.com/cdn/images/LByt7m02eR-6wZrXUk5d5/JXS6tZ4EbKIkeGpjP6QKc.svg"></object>
</div>
<div class="expander-hover-title">API Client</div>
<div class="expander">
<div class="expander-content">
Minimal, powerful, fully open-source API Client built on open standards by us + our community.
</div>
</div>
<a class="expander-hover-link" href="https://client.scalar.com/" target="_blank" aria-label="Learn more about API Client">Learn More</a>
</div>
</div>
<div class="relative">
<div class="expander-hover-sticker">
<object class="sticker-clip-sdk" width="145" height="145"
data="https://api.scalar.com/cdn/images/LByt7m02eR-6wZrXUk5d5/gM-mqYTBYMkqpnexTIr-r.svg"></object>
</div>
<div class="expander-hover-title">SDKs</div>
<div class="expander">
<div class="expander-content">
Bring your OpenAPI document and get type-safe client libraries for TypeScript, Python and more.
</div>
</div>
<a class="expander-hover-link" href="/products/sdks/getting-started" aria-label="Learn more about SDKs">Learn More</a>
</div>
</div>
<div class="relative">
<div class="expander-hover-sticker">
<object class="sticker-clip-registry" width="136" height="186"
data="https://api.scalar.com/cdn/images/LByt7m02eR-6wZrXUk5d5/jgGF_IKsu-T_irS-6MMOy.svg"></object>
</div>
<div class="expander-hover-title">API Registry</div>
<div class="expander">
<div class="expander-content">
Managing & versioning OpenAPI Documents with a deep Git integration.
</div>
</div>
<a class="expander-hover-link" href="/products/registry/getting-started" aria-label="Learn more about API Registry">Learn More</a>
</div>
</div>
<div class="relative">
<div class="expander-hover-sticker">
<object class="sticker-clip-docs" width="113" height="143" data="https://api.scalar.com/cdn/images/LByt7m02eR-6wZrXUk5d5/HLhbFqJ4vSzo4UDEZX2dq.svg"></object>
</div>
<div class="expander-hover-title">Docs</div>
<div class="expander">
<div class="expander-content">
Documentation that stays in sync with your API. Markdown, MDX, Git Sync, and stunning API references.
</div>
</div>
<a class="expander-hover-link" href="/products/docs/getting-started" aria-label="Learn more about Docs">Learn More</a>
</div>