@scalar/client-side-rendering

Scalar Client-Side Rendering

Render the Scalar API Reference as static HTML using the CDN. No server-side dependencies required.

---

Scalar is an open-source API platform for teams who want beautiful developer interfaces without vendor lock-in.

• API References — Interactive API documentation from OpenAPI and AsyncAPI specs.
• Developer Docs — Write in Markdown/MDX, generate API references, sync with two-way Git.
• SDK Generator — Type-safe SDKs and CLIs in TypeScript, Python, Go, PHP, Java, and Ruby.
• API Client — Open-source, offline-first Postman alternative built on OpenAPI.

20M+ monthly npm installs · 15,500+ GitHub stars · MIT licensed · scalar.com

---

Installation

npm install @scalar/client-side-rendering

Usage

import { renderApiReference } from '@scalar/client-side-rendering'

const html = renderApiReference({
  pageTitle: 'My API Reference',
  config: {
    url: 'https://registry.scalar.com/@scalar/apis/galaxy?format=json',
  },
})

Choosing the bundle

By default the generated HTML loads the modern, code-split ESM build (.../@scalar/api-reference/esm.js) as a <script type="module">. Because it is code-split, less JavaScript blocks the first render.

To use the classic UMD bundle instead (loaded via <script src> and the window.Scalar global):

• cdn: 'https://.../@scalar/api-reference' — pin a specific UMD build.
• bundle: false — use the default UMD build.

You can also pass bundle: 'https://.../esm.js' to load a specific ESM build.

Content Security Policy

Passing a nonce implies a strict, nonce-based CSP. The ESM build loads its chunks with native import, which cannot carry a nonce, so those requests would be blocked unless your policy also has 'strict-dynamic'. For that reason, the UMD bundle is used automatically whenever a nonce is set — it is a single nonced <script> with no follow-up requests. If your CSP uses 'strict-dynamic' (or allow-lists the CDN host), pass bundle: true to opt back into the ESM build.

Community

We are API nerds. You too? Let's chat on Discord: https://discord.gg/scalar

License

The source code in this repository is licensed under MIT.