Files
quartz/docs/plugins/ReaderMode.md
saberzero1 cce45e0718 docs: add repository, enabled, required frontmatter to all plugin docs
Added repository, enabled, and required fields to the frontmatter of
all 44 plugin documentation files. Updated Plugins.base to include
these columns, matching the information previously in the manual tables.
Also filtered out internal plugins (Assets, Static, ComponentResources,
NotFoundPage) from the base query.
2026-05-24 19:46:42 +02:00

867 B

title, tags, image, new-in-v5, repository, enabled, required
title tags image new-in-v5 repository enabled required
ReaderMode
plugin/component
true 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