Redoc OpenAPI Documentation Renderer

Redoc is an open-source tool by Redocly for generating beautiful, three-panel API reference documentation from OpenAPI specifications. With 25,000+ GitHub stars and nearly 1 million weekly npm downloads, it is the most widely used API documentation renderer.

Installation

Use the upstream install or setup path that matches your environment:

• npx @redocly/cli build-docs openapi.yaml

Requirements and caveats from upstream:

• Redoc is provided as a CLI tool (also distributed as a Docker image), HTML tag, and React component.
• If you have Node installed, quickly generate documentation using npx:
• Docker Engine

Basic usage or getting-started notes:

• Generate documentation from the CLI

• bash

• The tool outputs by default to a file named redoc-static.html that you can open in your browser.

• Source: https://github.com/Redocly/redoc

• Extracted from upstream docs: https://raw.githubusercontent.com/Redocly/redoc/HEAD/README.md

Source

• Agent Skill Exchange