mirror of
https://github.com/quartz-community/reader-mode.git
synced 2026-07-22 02:50:23 +00:00
33 lines
601 B
Markdown
33 lines
601 B
Markdown
# @quartz-community/reader-mode
|
|
|
|
Adds a reader mode toggle button that hides sidebars for distraction-free reading.
|
|
|
|
## Installation
|
|
|
|
```bash
|
|
npx quartz plugin add github:quartz-community/reader-mode
|
|
```
|
|
|
|
## Usage
|
|
|
|
```yaml title="quartz.config.yaml"
|
|
plugins:
|
|
- source: github:quartz-community/reader-mode
|
|
enabled: true
|
|
layout:
|
|
position: left
|
|
priority: 35
|
|
group: toolbar
|
|
```
|
|
|
|
## Configuration
|
|
|
|
This plugin has no configuration options.
|
|
|
|
## Documentation
|
|
|
|
See the [Quartz documentation](https://quartz.jzhao.xyz/features/reader%20mode) for more information.
|
|
|
|
## License
|
|
|
|
MIT
|