Zen Mode

Zen Mode

Read your documentation without distractions.

Zen Mode hides the elements around the content of a page, like the header and the sidebar.

Switch to Zen Mode to show the difference.

Entering Zen Mode

Select the Zen Mode icon in the header or in the table of contents, or use a keyboard shortcut.

Zen Mode pages are available at the URL of a page with /zen-mode/ added after the locale, e.g. /zen-mode/getting-started/. Links to other pages stay in Zen Mode, and switching between view modes keeps the section you are reading.

Hidden elements

By default, Zen Mode hides the header and the sidebar. Use the displayOptions option to choose which elements to hide.

Pages with a hero always display their header, and splash pages are not available in Zen Mode.

SearchSwitch to normal mode

ContentsSpeaker viewToggle fullscreenExport as PDF

Contents

Close

Start Here

• Getting StartedLearn how to add the view modes to your documentation website with the Starlight View Modes plugin.
• Zen ModeRead your documentation without distractions.
• Presentation ModePresent any page of your documentation as a slide deck.
• ConfigurationAn overview of all the configuration options supported by the Starlight View Modes plugin.
• View Modes DataLearn how to use Starlight View Modes’ data to access information about view modes.
• CSS CustomizationLearn how to customize your Starlight site and the Starlight View Modes plugin with custom CSS.
• Internationalization (i18n)Learn how to configure your website with view modes to support multiple languages.

Zen Mode

1. Entering Zen Mode2
2. Hidden elements3