Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

redocusaurus

rohit-gohri81.1kMIT2.5.0TypeScript support: included

Redoc for DocusaurusV2

redoc, openapi, api, swagger, documentation, api-doc, docusaurus, docusaurus-preset

readme

Redocusaurus

npm npm Libraries.io dependency status for latest release Typed with TypeScript Build and Deploy GitHub branch checks state This project is using Percy.io for visual regression testing.

Redoc for Docusaurus.

Usage

Check the documentation on the website

Demo

See Examples

Packages

Redocusaurus

A Docusaurus Preset that combines the below 2 packages to easily add API doc(s) to your docs site.

Docusaurus Theme Redoc

A wrapper around RedocStandalone to make it match the Docusaurus Theme with added support for Dark Mode.

Docusaurus Plugin Redoc

A content plugin that creates pages from your OpenAPI files or URLs and renders them using the Redoc component from the theme.

Website

Docs website and example project show casing the preset in action with multiple different OpenAPI specs.

Who is using Redocusaurus?

See Who is using Redocusaurus? section in docs.

Contributing

Any help is greatly appreciated, check the DEVELOPMENT.md for help on how to setup the project in your local and CONTRIBUTING.md for general info about the contribution workflow.

Motivation

To have the documentation and API reference in the same site with the same headers/footers. Read more in the blog post, OpenAPI for Docusaurus.

See this issue, https://github.com/facebook/docusaurus/issues/638, and this gist, https://gist.github.com/rohit-gohri/b1a19f37702cfe4a6c5a47933a11785b for more details and history.

License

MIT License. Copyright (c) 2024 Rohit Gohri

changelog

Redocusaurus

redocusaurus@2.5.0

Patch Changes

docusaurus-plugin-redoc@2.5.0

Minor Changes

  • #424 5be48fc Thanks @serut! - feat: add support for passing spec directly to all components

    Update docs to add various missing things.

docusaurus-theme-redoc@2.5.0

Minor Changes

  • #424 5be48fc Thanks @serut! - feat: add support for passing spec directly to all components

    Update docs to add various missing things.

redocusaurus@2.4.0

Patch Changes

docusaurus-theme-redoc@2.4.0

Minor Changes

  • #416 f7f5467 Thanks @svenkonings! - Add ApiOperation component to import and display the definitions of API operations within your Docusaurus docs

redocusaurus@2.3.0

Patch Changes

docusaurus-theme-redoc@2.3.0

Minor Changes

Patch Changes

redocusaurus@2.2.3

Patch Changes

docusaurus-plugin-redoc@2.2.3

Patch Changes

docusaurus-theme-redoc@2.2.3

Patch Changes

redocusaurus@2.2.2

Patch Changes

docusaurus-plugin-redoc@2.2.2

Patch Changes

docusaurus-theme-redoc@2.2.2

Patch Changes

redocusaurus@2.2.1

Patch Changes

docusaurus-plugin-redoc@2.2.1

Patch Changes

docusaurus-theme-redoc@2.2.1

Patch Changes

redocusaurus@2.2.0

Patch Changes

docusaurus-theme-redoc@2.2.0

Minor Changes

  • #385 a986be6 Thanks @slorber! - Upgrade Docusaurus - add support for Docusaurus Faster (RsPack)

redocusaurus@2.1.2

Patch Changes

docusaurus-theme-redoc@2.1.2

Patch Changes

  • #378 0415860 Thanks @a-ignatov-parc! - Fixes incorrect CSS prefixing that breaks layout on mobile devices and resolves reintroduced issues with incorrect background color for code samples

redocusaurus@2.1.1

Patch Changes

docusaurus-plugin-redoc@2.1.1

Patch Changes

docusaurus-theme-redoc@2.1.1

Patch Changes

redocusaurus@2.1.0

Minor Changes

Patch Changes

docusaurus-plugin-redoc@2.1.0

Minor Changes

redocusaurus@2.0.2

docusaurus-plugin-redoc@2.0.2

docusaurus-theme-redoc@2.0.2

redocusaurus@2.0.1

docusaurus-theme-redoc@2.0.1

  • #323 252b9b9 Thanks @zackerydev! - chore(deps): Add webpack to peer dependencies of redoc theme, this fixes issue #322

redocusaurus@2.0.0

Patch Changes

docusaurus-plugin-redoc@2.0.0

docusaurus-theme-redoc@2.0.0

redocusaurus@1.6.4

Patch Changes

docusaurus-theme-redoc@1.6.4

Patch Changes

redocusaurus@1.6.3

Patch Changes

docusaurus-theme-redoc@1.6.3

Patch Changes

redocusaurus@1.6.2

Patch Changes

docusaurus-theme-redoc@1.6.2

Patch Changes

redocusaurus@1.6.1

Patch Changes

docusaurus-theme-redoc@1.6.1

Patch Changes

redocusaurus@1.6.0

Minor Changes

Patch Changes

docusaurus-plugin-redoc@1.6.0

Minor Changes

docusaurus-theme-redoc@1.6.0

Minor Changes

Patch Changes

redocusaurus@1.5.1

Patch Changes

docusaurus-plugin-redoc@1.5.1

Patch Changes

docusaurus-theme-redoc@1.5.1

Patch Changes

redocusaurus@1.5.0

Patch Changes

docusaurus-plugin-redoc@1.5.0

Patch Changes

docusaurus-theme-redoc@1.5.0

Minor Changes

Patch Changes

redocusaurus@1.4.0

Patch Changes

docusaurus-plugin-redoc@1.4.0

Minor Changes

docusaurus-theme-redoc@1.4.0

Minor Changes

redocusaurus@1.3.0

Patch Changes

docusaurus-theme-redoc@1.3.0

Minor Changes

redocusaurus@1.2.3

Patch Changes

docusaurus-plugin-redoc@1.2.3

Patch Changes

  • #219 70d14f9 Thanks @mauris! - Update paths to watch for handling multi-file OpenAPI docs

docusaurus-theme-redoc@1.2.3

Patch Changes

redocusaurus@1.2.2

Patch Changes

docusaurus-theme-redoc@1.2.2

Patch Changes

redocusaurus@1.2.1

Patch Changes

docusaurus-plugin-redoc@1.2.1

Patch Changes

docusaurus-theme-redoc@1.2.1

Patch Changes

redocusaurus@1.2.0

Minor Changes

Patch Changes

docusaurus-plugin-redoc@1.2.0

Minor Changes

Patch Changes

docusaurus-theme-redoc@1.2.0

Minor Changes

Patch Changes

redocusaurus@1.1.3

Patch Changes

docusaurus-theme-redoc@1.1.3

Patch Changes

redocusaurus@1.1.2

Patch Changes

docusaurus-plugin-redoc@1.1.2

Patch Changes

docusaurus-theme-redoc@1.1.2

Patch Changes

redocusaurus@1.1.1

Patch Changes

docusaurus-theme-redoc@1.1.1

Patch Changes

redocusaurus@1.1.0

Patch Changes

docusaurus-theme-redoc@1.1.0

Minor Changes

redocusaurus@1.0.4

Patch Changes

docusaurus-theme-redoc@1.0.4

Patch Changes

redocusaurus@1.0.3

Patch Changes

docusaurus-plugin-redoc@1.0.3

Patch Changes

docusaurus-theme-redoc@1.0.3

Patch Changes

redocusaurus@1.0.2

Patch Changes

docusaurus-theme-redoc@1.0.2

Patch Changes

redocusaurus@1.0.1

Patch Changes

docusaurus-theme-redoc@1.0.1

Patch Changes

redocusaurus@1.0.0

Major Changes

Patch Changes

docusaurus-plugin-redoc@1.0.0

Major Changes

Minor Changes

docusaurus-theme-redoc@1.0.0

Major Changes

Minor Changes

Patch Changes

redocusaurus@0.9.2

Patch Changes

docusaurus-theme-redoc@0.9.2

Patch Changes

redocusaurus@0.9.1

Patch Changes

docusaurus-theme-redoc@0.9.1

Patch Changes

docusaurus-plugin-redoc@0.9.0

Patch Changes

redocusaurus@0.9.0

Patch Changes

docusaurus-theme-redoc@0.9.0

Minor Changes

Patch Changes

redocusaurus@0.8.0

Patch Changes

docusaurus-theme-redoc@0.8.0

Minor Changes

  • #129 717d36b Thanks @serut! - feat(theme): allow override redoc theme inside docusaurus.config file

redocusaurus@0.7.0

Patch Changes

docusaurus-plugin-redoc@0.7.0

Minor Changes

  • #124 9e97e62 Thanks @awarrenlove! - Add addRoute option to create a route for the generated docs, default to true

redocusaurus@0.6.0

Minor Changes

Patch Changes

docusaurus-theme-redoc@0.6.0

Minor Changes

docusaurus-plugin-redoc@0.6.0

Minor Changes

redocusaurus@0.5.1

Patch Changes

docusaurus-theme-redoc@0.5.1

Patch Changes

redocusaurus@0.5.0

Patch Changes

docusaurus-theme-redoc@0.5.0

Minor Changes

Patch Changes

docusaurus-plugin-redoc@0.5.0

Minor Changes

Patch Changes

redocusaurus@0.4.6

Patch Changes

docusaurus-theme-redoc@0.4.6

Patch Changes

docusaurus-plugin-redoc@0.4.6

Patch Changes

  • 2b50a09 #78 Thanks @rohit-gohri! - Allow passing both spec and specUrl to have custom yml as download button

redocusaurus@0.4.5

Patch Changes

docusaurus-theme-redoc@0.4.5

Patch Changes

redocusaurus@0.4.4

Patch Changes

docusaurus-theme-redoc@0.4.4

Patch Changes

redocusaurus@0.4.3

Patch Changes

docusaurus-theme-redoc@0.4.3

Patch Changes

docusaurus-theme-redoc@0.4.2

Patch Changes

redocusaurus@0.4.1

Patch Changes

docusaurus-theme-redoc@0.4.1

Patch Changes

docusaurus-plugin-redoc@0.4.1

Patch Changes

redocusaurus@0.4.0

Patch Changes

docusaurus-theme-redoc@0.4.0

Minor Changes

Patch Changes

docusaurus-plugin-redoc@0.4.0

Patch Changes