Controls the layout of the API docs page, affecting how the panels are displayed. The default value is three-panel which uses the default layout with the sidebar, middle panel, and right panel with code samples. Set the value to stacked to move the entire right panel into the middle panel. The stacked layout is identical to the layout activated by selecting the Change View button on the API documentation page.
The layout setting is not available in Redoc Community Edition.
The layout option is a string that sets the layout of the API documentation page.
| Option | Type | Enum | Description |
|---|---|---|---|
| layout | string | three-panel | stacked. | Controls the layout of the API docs page. Default value is three-panel. |
The following example configures the layout for the API documentation page to be set to stacked:
redocly.yaml
openapi:
layout: 'stacked'
redocly.yaml
openapi:
layout: 'three-panel'
- OpenAPI configuration - Complete guide to OpenAPI configuration options for customizing API reference documentation
- OpenAPI Specification - Official OpenAPI Specification documentation for understanding API description standards
- OpenAPI visual reference - Visual guide to OpenAPI specification structure and layout configuration principles
- Configuration options - Explore other project configuration options for comprehensive documentation customization