mirror of
https://github.com/quartz-community/reader-mode.git
synced 2026-11-17 00:03:39 +00:00
Quartz's default reader mode plugin.
- TypeScript 95.9%
- SCSS 4.1%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
|
|
||
| .changeset | ||
| .github/workflows | ||
| src | ||
| test | ||
| types | ||
| .eslintrc.json | ||
| .gitignore | ||
| .prettierignore | ||
| .prettierrc | ||
| CHANGELOG.md | ||
| LICENSE | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
| tsconfig.build.json | ||
| tsconfig.json | ||
| tsup.config.ts | ||
| vitest.config.ts | ||
@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