Last updated

layout

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 option is a string that sets the layout of the API documentation page.

Options

OptionTypeEnumDescription
layoutstringthree-panel | stacked.Controls the layout of the API docs page. Default value is three-panel.

Examples

The following example configures the layout for the API documentation page to be set to stacked:

redocly.yaml
openapi:
  layout: 'stacked'

stacked layout

redocly.yaml
openapi:
  layout: 'three-panel'

three panel layout

  • openapi - Learn more about using openapi configuration.

Resources

 
Next page