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: about 18 hours 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: 2024-11-10T13:40:01.000Z (about 1 month ago)
• Last Synced: 2024-12-04T15:07:10.866Z (8 days ago)
• Topics: documentation, docusaurus, docusaurus-plugin, docusaurus2, hacktoberfest, open-api, openapi, openapi-documentation, redoc, typescript
• Language: TypeScript
• Homepage: https://redocusaurus.vercel.app/
• Size: 19.7 MB
• Stars: 647
• Watchers: 9
• Forks: 113
• Open Issues: 34
• 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

[![npm](https://img.shields.io/npm/v/redocusaurus)](https://www.npmjs.com/package/redocusaurus/)

![npm](https://img.shields.io/npm/dw/redocusaurus)

![Libraries.io dependency status for latest release](https://img.shields.io/librariesio/release/npm/redocusaurus)

[![Typed with TypeScript](https://img.shields.io/badge/Typed-555555.svg?logo=typescript&labelColor=fff)](https://www.typescriptlang.org/)

[![Build and Deploy](https://github.com/rohit-gohri/redocusaurus/actions/workflows/build.yml/badge.svg)](https://github.com/rohit-gohri/redocusaurus/actions/workflows/build.yml)

![GitHub branch checks state](https://img.shields.io/github/checks-status/rohit-gohri/redocusaurus/main?logo=github)

[![This project is using Percy.io for visual regression testing.](https://percy.io/static/images/percy-badge.svg)](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)