Redocusaurus

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