2.0.2 • Published 2 months ago

redocusaurus v2.0.2

Weekly downloads
289
License
MIT
Repository
github
Last release
2 months ago

Redocusaurus

npm

Redoc for Docusaurus v2.

Usage

  1. Install redocusaurus:

    npm i --save redocusaurus
  2. 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.

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.

2.0.2

2 months ago

2.0.1

3 months ago

2.0.0

6 months ago

1.6.4

8 months ago

1.6.3

11 months ago

1.6.2

1 year ago

1.6.1

1 year ago

1.6.0

1 year ago

1.5.1

1 year ago

1.5.0

1 year ago

1.4.0

2 years ago

1.2.0

2 years ago

1.2.3

2 years ago

1.2.2

2 years ago

1.2.1

2 years ago

1.1.1

2 years ago

1.1.3

2 years ago

1.3.0

2 years ago

1.1.2

2 years ago

1.1.0

2 years ago

1.0.4

2 years ago

1.0.3

2 years ago

1.0.2

2 years ago

1.0.1

2 years ago

1.0.0

2 years ago

0.9.2

2 years ago

0.9.1

2 years ago

0.9.0

2 years ago

0.8.0

2 years ago

0.7.0

2 years ago

0.6.0

2 years ago

0.5.1

2 years ago

0.5.0

2 years ago

0.5.0-next.0

3 years ago

0.4.6

3 years ago

0.4.5

3 years ago

0.4.4

3 years ago

0.4.3

3 years ago

0.4.1

3 years ago

0.4.0-beta.0

3 years ago

0.4.0

3 years ago

0.3.4

3 years ago

0.3.3

3 years ago

0.3.2

3 years ago

0.3.1

3 years ago

0.3.0

3 years ago

0.2.2

3 years ago

0.2.1

3 years ago

0.1.0

3 years ago

0.2.0

3 years ago

0.0.0

3 years ago