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
46 commits 1 branch 0 tags 172 KiB
TypeScript 94.4%
SCSS 5.6%
Find a file
saberzero1 9127bb6662
deps: update @quartz-community/utils
2026-04-22 18:19:04 +02:00
.github/workflows ci: add dist externals verification step 2026-03-17 19:41:47 +01:00
dist fix: bundle @quartz-community/utils to avoid runtime subpath resolution failures 2026-04-04 11:36:38 +02:00
src i18n: add translations for 30 locales from Quartz v4 2026-04-04 01:44:22 +02:00
test feat: migrate ReaderMode component from Quartz v5 core 2026-02-13 17:14:35 +01:00
types chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.eslintrc.json chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
.gitignore chore: commit dist/ and remove prepare script 2026-03-14 22:00:48 +01:00
.prettierignore chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +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/utils 2026-04-22 18:19:04 +02:00
package.json deps: add @quartz-community/utils dependency 2026-04-03 19:33:12 +02:00
README.md docs: update README for v5 unified config system 2026-02-25 16:07:11 +01:00
tsconfig.build.json fix: use separate tsconfig for DTS build to avoid vitest dependency 2026-03-22 13:12:01 +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: bundle @quartz-community/utils to avoid runtime subpath resolution failures 2026-04-04 11:36:38 +02: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