Skip to content

lugg/redocusaurus

 
 

Repository files navigation

Redocusaurus

npm lerna Typed with TypeScript

Redoc for Docusaurus v2.

Usage

See Redocusaurus Package.

Demo

See: https://rohit-gohri.github.io/redocusaurus/

Packages

A wrapper around RedocStandalone to make it match the Dcousaurus Theme with added Dark Mode.

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

A Docusaurus Preset that uses the above 2 plugins to easily add API docs to your docs site.

Example project show casing the preset in action with multiple different OpenAPI specs.

Motivation

To have the documentaion 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.