Distraction-free reading mode.

Note

For information on how to add, remove or configure plugins, see the Configuration page.

See reader mode for detailed usage information.

Configuration

This plugin has no options. Use the entry’s enabled field to turn it on or off, and layout to place the toggle button.

On folder and tag pages the default config leaves the button out (layout.byPageType.folder.exclude: [reader-mode]).

Default options

quartz.config.yaml
- source: "@quartz-community/reader-mode"
  enabled: true
  layout:
    position: left
    priority: 35
    group: toolbar

API

  • Category: Component
  • Function name: ExternalPlugin.ReaderMode().
  • Source: quartz-community/reader-mode
  • Install: npx quartz plugin add @quartz-community/reader-mode (included in the default configuration)