Quartz's default reader mode plugin.
  • TypeScript 95.9%
  • SCSS 4.1%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-09 23:04:25 +01:00
.changeset chore: version package 2026-11-09 04:09:27 +00:00
.github/workflows ci: run ci.yml on the changesets version PR and report it as a commit status 2026-11-09 03:47:26 +01:00
src fix: add aria-label to reader mode toggle button 2026-05-24 16:21:07 +02:00
test feat: migrate ReaderMode component from Quartz v5 core 2026-02-13 17:14:35 +01:00
types chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.eslintrc.json chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.gitignore chore: migrate to npm publishing 2026-07-23 09:07:31 +02:00
.prettierignore chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.prettierrc Initial commit 2026-02-13 16:52:46 +01:00
CHANGELOG.md chore: version package 2026-11-09 04:09:27 +00:00
LICENSE Initial commit 2026-02-13 16:52:46 +01:00
package-lock.json chore: version package 2026-11-09 04:09:27 +00:00
package.json chore: version package 2026-11-09 04:09:27 +00:00
README.md docs(readme): Quartz 5.1 — npm install and config, correct options and defaults 2026-11-09 22:57:50 +01:00
tsconfig.build.json fix: use separate tsconfig for DTS build to avoid vitest dependency 2026-03-22 13:12:01 +01:00
tsconfig.json fix: resolve ESLint and formatting issues for CI compliance 2026-03-09 03:46:54 +01:00
tsup.config.ts build: keep preact and the other shared packages external (tsup's noExternal overrode them) 2026-11-09 04:49:36 +01:00
vitest.config.ts fix: add passWithNoTests to vitest config 2026-03-09 03:21:30 +01:00

@quartz-community/reader-mode

Adds a reader mode toggle button that hides sidebars for distraction-free reading.

Installation

npx quartz plugin add @quartz-community/reader-mode

Reader mode is already in Quartz's default configuration.

Usage

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

Configuration

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

Documentation

See the Quartz documentation for more information.

License

MIT