@chargeover/redocusaurus

Redocusaurus

Redoc for Docusaurus v2.

Usage

1. Install redocusaurus:

npm i --save redocusaurus
# OR
yarn add redocusaurus

1. Add it as a preset to your docusaurus config along with @docusaurus/preset-classic and pass options:

   • Pass it a path to a local OpenAPI YAML file

   // docusaurus.config.js
   
   module.exports = {
     // ...
     presets: [
        // .. Your other presets' config 
        '@docusaurus/preset-classic',
        // Redocusaurus config
       [
         'redocusaurus',
         {
           // Plugin Options for loading OpenAPI files
           specs: [
             {
               spec: 'openapi/openapi.yaml',
               route: '/api/',
             },
           ],
           // Theme Options for modifying how redoc renders them
           theme: {
             // Change with your site colors
             primaryColor: '#1890ff',
           },
         },
       ],
     ],
     // ...
   };

• OR Pass it a OpenAPI spec URL

  // docusaurus.config.js
  
  module.exports = {
    // ...
    presets: [
       // .. Your other presets' config 
       '@docusaurus/preset-classic',
       // Redocusaurus config
      [
        'redocusaurus',
        {
          // Plugin Options for loading OpenAPI files
          specs: [
            {
              spec: 'https://redocly.github.io/redoc/openapi.yaml',
              route: '/api/',
            },
          ],
          // Theme Options for modifying how redoc renders them
          theme: {
            // Change with your site colors
            primaryColor: '#1890ff',
          },
        },
      ],
    ],
    // ...
  };

The API Doc will be available at the route specified (/api/ in the example above). To customize it see full plugin options.

Options

specs

Pass it an array of plugin options, see docusaurus-plugin-redoc for individual option details.

theme

Pass options to customize the theme, see docusaurus-theme-redoc for individual option details.

Docs

See: https://redocusaurus.vercel.app/docs