https://github.com/rohit-gohri/redocusaurus
OpenAPI for Docusaurus with Redoc
https://github.com/rohit-gohri/redocusaurus
documentation docusaurus docusaurus-plugin docusaurus2 hacktoberfest open-api openapi openapi-documentation redoc typescript
Last synced: 12 days ago
JSON representation
OpenAPI for Docusaurus with Redoc
- Host: GitHub
- URL: https://github.com/rohit-gohri/redocusaurus
- Owner: rohit-gohri
- License: mit
- Created: 2020-08-29T06:39:32.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2025-03-31T17:16:28.000Z (22 days ago)
- Last Synced: 2025-04-03T08:04:02.810Z (19 days ago)
- Topics: documentation, docusaurus, docusaurus-plugin, docusaurus2, hacktoberfest, open-api, openapi, openapi-documentation, redoc, typescript
- Language: TypeScript
- Homepage: https://redocusaurus.vercel.app/
- Size: 20 MB
- Stars: 678
- Watchers: 8
- Forks: 116
- Open Issues: 38
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome - rohit-gohri/redocusaurus - OpenAPI for Docusaurus with Redoc (TypeScript)
README
# Redocusaurus
[](https://www.npmjs.com/package/redocusaurus/)


[](https://www.typescriptlang.org/)
[](https://github.com/rohit-gohri/redocusaurus/actions/workflows/build.yml)

[](https://percy.io/fef74697/redocusaurus)[Redoc](https://github.com/redocly/redoc) for [Docusaurus](https://docusaurus.io/).
## Usage
Check the [documentation on the website](https://redocusaurus.vercel.app/docs)
## Demo
See [Examples](https://redocusaurus.vercel.app/examples/)
## Packages
### [Redocusaurus](./packages/redocusaurus)
A Docusaurus Preset that combines the below 2 packages to easily add API doc(s) to your docs site.
### [Docusaurus Theme Redoc](./packages/docusaurus-theme-redoc)
A wrapper around `RedocStandalone` to make it match the Docusaurus Theme with added support for Dark Mode.
### [Docusaurus Plugin Redoc](./packages/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](./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.](https://redocusaurus.vercel.app/docs/who-is-using-redocusaurus)
## Contributing
Any help is greatly appreciated, check the [DEVELOPMENT.md](./DEVELOPMENT.md) for help on how to setup the project in your local and [CONTRIBUTING.md](./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](https://rohit.page/blog/projects/openapi-for-docusaurus/?utm_source=github&utm_medium=repo&utm_campaign=redocusaurus).
See this issue, [https://github.com/facebook/docusaurus/issues/638](https://github.com/facebook/docusaurus/issues/638#issuecomment-762502498), and this gist, for more details and history.
## License
[MIT License. Copyright (c) 2024 Rohit Gohri](./LICENSE)