@redocly/revel
v0.132.0
Published
Revel is Redocly's external developer showcase platform that transforms your API into a branded experience.
Downloads
2,209
Keywords
Readme
Revel
Revel is Redocly's external developer showcase platform that transforms your API into a branded experience.
Features
- 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 a 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
- Redocly Integration - works seamlessly with Redoc for API docs and Reef for internal catalogs
Refer to Redocly documentation for detailed configuration options.
You can explore a live deployment of Revel at https://redocly.com - our main website is built with it.
You can explore a live deployment of Revel at https://redocly.com - this website runs entirely on Realm (which includes Revel).
Installation
Install Revel using npm:
npm install @redocly/revelOr using pnpm:
pnpm add @redocly/revelOr using yarn:
yarn add @redocly/revelUsage
Revel is designed to work seamlessly as part of the Redocly ecosystem. It integrates with:
- Redoc - for API reference documentation and mock servers
- Reef - for internal service catalogs
- Realm - the complete combination of Redoc, Revel, and Reef
- Reunite - for docs-as-code workflows and collaboration
Support
Built with 💙 by Redocly
