redocusaurus 0.7.0-v4
Install from the command line:
Learn more about npm packages
$ npm install @ahana-inc/redocusaurus@0.7.0-v4
Install via package.json:
"@ahana-inc/redocusaurus": "0.7.0-v4"
About this version
Redoc for Docusaurus v2.
-
Install redocusaurus:
npm i --save redocusaurus
-
Add it as a preset to your docusaurus config and pass options:
-
Pass it a OpenAPI spec URL
// docusaurus.config.js module.exports = { // ... presets: [ [ 'redocusaurus', { specs: [{ specUrl: 'https://redocly.github.io/redoc/openapi.yaml', }], } ], ], // ... }
-
Pass it a OpenAPI spec local path
// docusaurus.config.js module.exports = { // ... presets: [ [ 'redocusaurus', { specs: [{ spec: 'openapi.yaml', }], } ], ], // ... }
-
The API Doc will be available by default at /api/ path. To customize it see full plugin options.
Pass it an array of plugin options, see docusaurus-plugin-redoc for individual option details.
Pass options to customize the theme, see docusaurus-theme-redoc for individual option details.
