@kubb/plugin-redoc

Generate API documentation using Redoc.

Installation

bun

bun add -d @kubb/plugin-redoc

pnpm

pnpm add -D @kubb/plugin-redoc

npm

npm install --save-dev @kubb/plugin-redoc

yarn

yarn add -D @kubb/plugin-redoc

Options

output

output.path

The output location for the generated documentation.

This plugin uses Redocly for HTML generation.

Type:	string
Required:	false
Default:	'docs.html'

Example

kubb.config.ts

import { defineConfig } from '@kubb/core'
import { pluginRedoc } from '@kubb/plugin-redoc'

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

See Also

• https://redocly.com/