# Redoc-Revel

The Redoc-Revel package combines Redocly's tool for generating API documentation from API description files with Redocly's external developer showcase platform.

## Features

- **API documentation** - transform API description files into responsive, human-readable API documentation with automatically generated code samples
- Specification support:
  - **OpenAPI** (formerly Swagger)
  - **GraphQL**
  - **AsyncAPI**
  - **SOAP**
- **Mock servers** - test your OpenAPI documentation with automatically created mock server at your custom domain
- **Linting** - use built-in rules or create custom rules to govern your APIs
- **Markdown Docs** - write content in Markdown and enhance it using built-in or custom Markdoc tags
- **React Pages** - build custom pages with React to create modern experience
- **Component ejection** - eject and customize any component to bring your theming and branding
- **Multi-product support** - manage and showcase multiple API products with separate configuration for each product
- **Localization** - present your API in multiple languages for a global audience

## Live demo

You can explore a live deployment of Revel at [https://redocly.com](https://redocly.com) - this website runs entirely on Realm (which includes Revel).

For a demo of Redoc, see our [Museum API](https://redocly.com/demo/openapi/museum-api).

## Installation

Install Redoc-Revel using npm:

```bash
npm install @redocly/redoc-revel
```

Or using pnpm:

```bash
pnpm add @redocly/redoc-revel
```

Or using yarn:

```bash
yarn add @redocly/redoc-revel
```

## Usage

Redoc-Revel integrates with Reunite for docs-as-code workflows and collaboration.

## Support

- [Documentation](https://redocly.com/docs)
- [Contact the Redocly team](https://redocly.com/contact-us)

---

Built with 💙 by Redocly