demo-vault/docs/plugins/ReaderMode.md
2026-05-25 13:10:44 +02:00

969 B

title description tags image new-in-v5 repository enabled required
ReaderMode Distraction-free reading mode toggle.
plugin/component
true [quartz-community/reader-mode](https://github.com/quartz-community/reader-mode) true false

Distraction-free reading mode.

Note

For information on how to add, remove or configure plugins, see the configuration#Plugins page.

See reader mode for detailed usage information.

Configuration

This plugin accepts the following configuration options:

  • enabled: Whether to enable reader mode. Defaults to true.

Default options

- source: github:quartz-community/reader-mode
  enabled: true

API

  • Category: Component
  • Function name: ExternalPlugin.ReaderMode().
  • Source: quartz-community/reader-mode
  • Install: npx quartz plugin add github:quartz-community/reader-mode