Skip to content
Officialv5.0.6MITkubb >=5.0.0node >=22

@kubb/plugin-redoc

Generates a single-file HTML page from your OpenAPI spec with Redoc, rebuilt on every Kubb run so the docs match the spec your code comes from.

redocapi-docsdocumentationinteractive-docscodegenopenapi
Stijn Van Hulle

Stijn Van Hulle

@stijnvanhulle

Downloads
41.7K/ mo
Stars
8
Bundle size
28.4 kB
Updated
2h ago

Generate a single HTML documentation page with Redoc.

  • Embed the spec and publish to a static host without building.
  • Network access is required for CDN scripts and fonts.

Installation

bun add -d @kubb/plugin-redoc

Or run kubb add plugin-redoc to install the version the Kubb registry pins and add pluginRedoc() to kubb.config.ts.

Dependencies

  • No plugin dependencies or Redoc runtime package.
  • Uses Kubb's default OpenAPI adapter.

Example

kubb.config.ts
import { defineConfig } from 'kubb/config'
import { pluginRedoc } from '@kubb/plugin-redoc'

export default defineConfig({
  input: './petStore.yaml',
  output: { path: './src/gen' },
  plugins: [
    pluginRedoc({ output: { path: 'docs.html' } }),
  ],
})

See also

Options