OrbitDocs packages are coming to npm soon. Until then, run it from the GitHub repo →
Help

OrbitDocs vs Scalar

An honest feature comparison, including where Scalar is the better choice.

Scalar makes an excellent open-source API reference and API client, plus a hosted platform with docs, a registry, SDKs and MCP. OrbitDocs covers the same ground, but every part runs on your own infrastructure under the MIT license. This page compares the two as fairly as we can.

Scalar changes quickly. The Scalar column reflects its public offering as of October 2026. Check Scalar's own docs before deciding.

At a glance

OrbitDocsScalar
LicenseMIT, everythingMIT for the API reference and API client; the platform is a hosted, paid service
Self-hostingEverything, including the platformThe open-source reference and client only
Hosted serviceNoneYes
PriceFreeFree open-source pieces; paid hosted plans

Feature by feature

FeatureOrbitDocsScalar
API reference from OpenAPIYes. One scrolling page plus a URL per operationYes (open source)
API clientYes. Environments, collections, scripts, runner, historyYes (open source)
MDX guides next to the referenceYes, in your repository, deployed anywhereScalar Docs, hosted only
Static exportYes (output.mode: 'static')No for Scalar Docs
Serve the docs from your NestJS appYes, guides and reference (mountOrbitDocs)The API reference
Spec from NestJS without running the appYes. Preview-mode extraction, no database neededNo. Uses the spec your app produces
Private docs with SSOYes. Six OIDC presets and four app-session adapters, on your serverHosted plans
Ask AI over your docsYes, with your own LLM keyHosted only
MCP servers (docs and API)Yes, self-hostedHosted only
llms.txt and Markdown per pageYesCheck Scalar's docs
SDK generationYes. CLI, six languages, runs locally or in your CIHosted only
Mock serverYes (orbitdocs mock, built on Scalar's open-source mock server)Yes (open source)
Spec lintingYes. Spectral, custom rulesetsCheck Scalar's docs
Spec registryYes, self-hostedHosted only
Git sync with GitHubYesYes
Git sync with GitLab (including self-managed)YesNo
Preview site per pull or merge requestYesCheck Scalar's docs
Custom domains with automatic HTTPSYes (Caddy)Hosted
Roles per projectOwner, admin, editor, viewerHosted plans
SCIM provisioningYesNo
Audit logYesNo
AnalyticsBuilt-in (no cookies), Plausible, Umami or PostHogCheck Scalar's docs

Where Scalar is the better choice

  • You don't want to run servers. Scalar's platform is managed. OrbitDocs' platform is yours to install, back up and upgrade.
  • You use many frameworks. Scalar ships integrations for many languages and frameworks. OrbitDocs is NestJS-first; other APIs use a spec file or URL.
  • You need features OrbitDocs leaves out. OrbitDocs has no translated guides, social preview images or RSS feed yet, no SAML, and no automated breaking-change detection or changelog.
  • You want a larger community. Scalar has a bigger user base and ecosystem.

Where OrbitDocs fits better

  • Everything must stay on your infrastructure, for compliance or air-gapped networks.
  • You use GitLab, hosted or self-managed.
  • You need SCIM and an audit log for the docs platform.
  • Your API is NestJS, and you want the reference generated from code with no running database.
  • You want static files you can host anywhere, or docs served by the API itself.

Moving from Scalar

The API reference and client read standard OpenAPI, so your spec works as is:

orbitdocs.config.ts
import { defineConfig } from '@orbitdocs/next/config';

export default defineConfig({
  site: { title: 'Acme API' },
  apis: [{ id: 'acme', source: { file: './openapi.yaml' } }],
});

Move Markdown guides into content/ as .mdx files with title and description frontmatter. Then follow the Quickstart.

Last updated on

On this page