Embedded mode

Embedded mode removes the header and footer from your documentation pages, making them suitable for embedding in iframes, dashboards, or other contexts where you want to display only the content.

Enable embedded mode

Add the embedded=true query parameter to any documentation URL:

https://docs.example.com/getting-started?embedded=true

When enabled, the header (including navigation and logo) and footer are hidden, and the main content area adjusts to fill the available space.

Persistence

Once embedded mode is activated, it persists across navigation events within the same session. Users can navigate between pages without needing to add the query parameter to each URL.

Use cases

Embedded mode is useful when you want to:

• Display documentation within a product dashboard or admin panel
• Create a seamless experience when embedding docs in an iframe
• Show documentation content without the standard navigation chrome