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
15 commits 1 branch 0 tags 172 KiB
TypeScript 94.4%
SCSS 5.6%
Find a file
saberzero1 740ca9ae12
chore: move build tools to devDependencies, shared deps to peerDependencies 
tsup and typescript are only needed at build time — move to devDependencies
so they can be pruned after build. Dependencies already available from the
host Quartz installation are moved to peerDependencies to avoid duplication.
2026-03-14 21:27:30 +01:00
.github/workflows Initial commit 2026-02-13 16:52:46 +01:00
src feat: add render event listener for in-place DOM re-initialization 2026-03-12 19:45:32 +01:00
test feat: migrate ReaderMode component from Quartz v5 core 2026-02-13 17:14:35 +01:00
types fix: resolve ESLint and formatting issues for CI compliance 2026-03-09 03:46:54 +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 deps: update @quartz-community/types and @quartz-community/utils 2026-03-09 03:04:03 +01:00
package.json chore: move build tools to devDependencies, shared deps to peerDependencies 2026-03-14 21:27:30 +01:00
README.md docs: update README for v5 unified config system 2026-02-25 16:07:11 +01:00
tsconfig.json fix: resolve ESLint and formatting issues for CI compliance 2026-03-09 03:46:54 +01:00
tsup.config.ts fix: compile SCSS via sass instead of raw text to prevent lightningcss errors 2026-02-26 16:44:51 +01:00
vitest.config.ts fix: add passWithNoTests to vitest config 2026-03-09 03:21:30 +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

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 for more information.

License

MIT