quartz-community/reader-mode
1
0
Fork 0
mirror of https://github.com/quartz-community/reader-mode.git synced 2026-07-22 02:50:23 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: update README for v5 unified config system

Browse source
This commit is contained in:
saberzero1 2026-02-25 16:07:11 +01:00
parent de7fa4934d
commit d81120f30b
No known key found for this signature in database
1 changed files with 9 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -10,12 +10,14 @@ npx quartz plugin add github:quartz-community/reader-mode
## Usage
```ts
// quartz.layout.ts
import * as Plugin from "./.quartz/plugins";
// Add to your layout
Plugin.ReaderMode(); // in the appropriate layout section
```yaml title="quartz.config.yaml"
plugins:
- source: github:quartz-community/reader-mode
enabled: true
layout:
position: left
priority: 35
group: toolbar
```
## Configuration
@ -24,7 +26,7 @@ This plugin has no configuration options.
## Documentation
See the [Quartz documentation](https://quartz.jzhao.xyz/) for more information.
See the [Quartz documentation](https://quartz.jzhao.xyz/features/reader%20mode) for more information.
## License