Reference

Options

Configuration options for @kubb/plugin-redoc.
OptionTypeDefaultDescription
output{ path: string }{ path: 'docs.html' }Where the generated HTML file is written

output

Where the generated Redoc HTML file is written.

TypeDefault
{ path: string }{ path: 'docs.html' }

output.path

File path of the generated HTML, resolved against the global output.path. Unlike most plugins, this points at a single file, not a directory.

End the path with a .html extension. If you leave the extension off, Kubb still writes the file and uses the path as the plugin output name.

TypeDefault
string'docs.html'

With output.path set to 'docs.html' and the global output.path set to './src/gen', the plugin writes one file:

  • src/
  • gen/
  • docs.html

Overview