Redocly API Block - No Layout

Display the Redocly API Block without the standard page layout wrapper, creating a full-page, immersive API documentation experience.

Overview

Setting layout: none in the frontmatter removes the typical page layout elements (header, footer, sidebars), allowing the API documentation to occupy the full viewport. This is ideal for:

• Dedicated API reference pages
• Standalone API documentation
• Embedded documentation in external sites

Syntax

Add layout: none to the page frontmatter:

---
title: Your Page Title
layout: none
---

<RedoclyAPIBlock src="path/to/openapi.yaml" scrollYOffset={64} />

Parameters

• src: Path to OpenAPI specification file
• scrollYOffset: Offset in pixels for fixed headers (optional)

Example

data-src=../../assets/openapi.yaml

data-scrollYOffset=64

Related

• Redocly API Block Default - With standard layout
• Redocly API Block Configs - Configuration options