Skip to content

@kubb/plugin-redoc 🦙

With the Redoc plugin you can create beautiful documentation pages.


## Installation
shell
bun add @kubb/plugin-redoc
shell
pnpm add @kubb/plugin-redoc
shell
npm install @kubb/plugin-redoc
shell
yarn add @kubb/plugin-redoc

Options

output

output.path

Output for the generated doc, we are using https://redocly.com/ for the generation

INFO

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

typescript
import { 
pluginOas
} from '@kubb/plugin-oas'
const
plugin
=
pluginOas
({
output
: {
path
: './docs/index.html',
}, })

Example

typescript
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',
}, }), ], })

Released under the MIT License.