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
No description
7 commits 1 branch 0 tags 172 KiB
TypeScript 94.4%
SCSS 5.6%
Find a file
saberzero1 de7fa4934d
fix: move tsup and typescript to dependencies for git install compatibility
2026-02-23 01:10:15 +01:00
.github/workflows Initial commit 2026-02-13 16:52:46 +01:00
src feat: migrate ReaderMode component from Quartz v5 core 2026-02-13 17:14:35 +01:00
test feat: migrate ReaderMode component from Quartz v5 core 2026-02-13 17:14:35 +01:00
.eslintrc.json Initial commit 2026-02-13 16:52:46 +01:00
.gitignore Initial commit 2026-02-13 16:52:46 +01:00
.prettierrc Initial commit 2026-02-13 16:52:46 +01:00
CHANGELOG.md Initial commit 2026-02-13 16:52:46 +01:00
LICENSE Initial commit 2026-02-13 16:52:46 +01:00
package-lock.json chore: update @quartz-community/types to v0.2.1 2026-02-13 22:58:17 +01:00
package.json fix: move tsup and typescript to dependencies for git install compatibility 2026-02-23 01:10:15 +01:00
README.md docs: add plugin README 2026-02-14 02:13:33 +01:00
tsconfig.json Initial commit 2026-02-13 16:52:46 +01:00
tsup.config.ts fix: standardize inline script transpilation in tsup config 2026-02-14 01:11:36 +01:00
vitest.config.ts Initial commit 2026-02-13 16:52:46 +01:00

README.md

@quartz-community/reader-mode

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

Installation

npx quartz plugin add github:quartz-community/reader-mode

Usage

// quartz.layout.ts
import * as Plugin from "./.quartz/plugins";

// Add to your layout
Plugin.ReaderMode(); // in the appropriate layout section

Configuration

This plugin has no configuration options.

Documentation

See the Quartz documentation for more information.

License

MIT