RapiDoc 12.0.0

RapiDoc 12 renames its CSS variables to the shadcn/ui names, renders real headings, lays out parameters as lists instead of tables, and stops loading web fonts. It also adds a build-time static renderer and a curated MCP server generator.

:::bash
npm install rapidoc@12.0.0

⚠️ Breaking changes

Read the v11 → v12 migration guide before you upgrade. There are no compatibility aliases.

• CSS variables use shadcn/ui names. For example, --font-regular → --font-sans, --nav-* → --sidebar-*, --input-border → --input, and --red → --destructive for errors. Every variable now has a real default on the element. To pass a shadcn/ui site theme through, set --background: inherit; (and the others) on rapi-doc.
• Semantic headings. Titles render as <h1>–<h6> (API title h1, tags h2, operations h3, and so on). New parts: heading and heading-1 … heading-6. Section titles are now in normal case.
• Parameter lists replace tables. Parameters, form fields, response headers, server variables and the Authentication section used <table role="presentation">. They are now <ul class="param-list"> on a CSS grid. .m-table and #auth-table are gone. Copy buttons changed from part btn-fill to btn-outline.
• No web fonts are loaded. Text uses the system UI and monospace fonts. The load-fonts attribute is removed. To keep a brand font, load it yourself and set --font-sans / --font-mono.
• Five themes. ember (default, was amber), carbon (was graphite), cobalt (was blue), jade (was emerald) and indigo (was violet). rose, slate, modern and default are removed; pass a hex code such as theme="#e11d48" instead.

✨ New

• rapidoc/static: a build-time renderer with TypeScript declarations:
• renderRapiDoc, renderEndpoint and renderSchema pre-render pages with Declarative Shadow DOM, which hydrates automatically in the browser.
• getNavBarHtml, getNavCss and bindNavBar build a static sidebar next to a headless <rapi-doc>.
• Curated MCP server generator:
• mcp attribute: typescript, python, go, csharp, rust or java.
• mcp-server-name attribute and x-mcp-* vendor extensions.
• Methods generateMcpServer(), downloadMcpServer() and getMcpBudget().
• Three-level navigation:
• x-tagGroups with expandable tags.
• A "General" tag for untagged operations.
• x-internal / x-hidden filtering.
• Stable method + path anchors.
• color-scheme="auto" follows the host page's CSS color-scheme and updates when the page switches theme.
• scroll-offset keeps sections below a sticky page header when auto-height="true". It defaults to the page's scroll-padding-top.
• setApiKey(id, value, { note }) shows a note such as "Using your sign-in" in place of that scheme's form.
• Schemas:
• One-line descriptions with truncation cues.
• Null markers in schema tables.
• Property names shown on oneOf / anyOf properties.
• New CSS variables:
• Heading scale: --h1-font-size … --h6-font-size and --heading-*.
• Text sizes: --font-size-xs and --font-size-description.
• Spacing: --scroll-margin-top, --param-label-width and the other --param-* / --value-list-* spacing tokens.

💅 Improvements

• Accessibility:
• Light-theme method colours pass WCAG AA.
• Every theme now has a visible focus ring (--ring).
• No text is smaller than 11px.
• Allowed values and examples are keyboard-focusable chips.
• Authorization chips open an accessible popover.
• Controls: buttons, inputs and selects share two sizes that follow scale. The auth and response-tab controls are redesigned.
• Wide markdown tables scroll inside their own box instead of widening the page.
• Performance: schema rows are lighter, and plain-text descriptions skip the markdown parser.
• Components are written in TypeScript. Dependencies are updated to the latest versions: @scalar/openapi-parser 0.29.18, Lit 3.3, marked 18.

🐛 Fixes

• Swagger 2.0 securityDefinitions for oauth2 and basic now keep their description and x- fields (#1162).
• Tag pages no longer jump to the API overview on load.
• A relative spec-url is resolved against the page once.
• Only JSON nesting counts toward the schema depth limit.
• Length constraints are shown for formatted strings.
• The OAuth popup flow is hardened.
• The active navigation item stays in sync after scrollToPath().
• Pre-rendered HTML escapes plain bindings, as Lit does.

Full changelog: https://github.com/rapi-doc/RapiDoc/compare/v11.0.1...v12.0.0

🚀 What's next: RapiDoc Dev Portal

One of the most requested features in RapiDoc is pre-rendering: docs that search engines can fully index, while keeping the hands-on exploration developers love.

We think that exploration is what sets RapiDoc apart. Most OpenAPI renderers look the same. RapiDoc lets you walk through a schema and see every parameter, constraint and example in context.

12.0.0 lays the groundwork. The new rapidoc/static renderer pre-renders your API reference at build time, so the HTML is there for search engines from the first byte. The same page then turns into the full interactive RapiDoc in the browser.

Next up is the RapiDoc Dev Portal: a complete developer portal you host on your own server. It keeps RapiDoc's distinct look and adds guides, search and much more around your API reference.

Like RapiDoc, the Dev Portal will be completely free and open source. Stay tuned! ⭐ Star the repo to hear about it first.