Quartz's default darkmode plugin.
  • TypeScript 95.4%
  • SCSS 4.6%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-09 23:02:08 +01:00
.changeset chore: version package 2026-11-09 04:03:22 +00:00
.github/workflows ci: run ci.yml on the changesets version PR and report it as a commit status 2026-11-09 03:47:26 +01:00
src fix: add aria-label to dark mode toggle button 2026-05-24 16:21:07 +02: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: migrate to npm publishing 2026-07-23 09:07:00 +02: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:51:38 +01:00
CHANGELOG.md chore: version package 2026-11-09 04:03:22 +00:00
LICENSE Initial commit 2026-02-13 16:51:38 +01:00
package-lock.json chore: version package 2026-11-09 04:03:22 +00:00
package.json chore: version package 2026-11-09 04:03:22 +00:00
README.md docs(readme): Quartz 5.1 — npm install and config, correct options and defaults 2026-11-09 22:56:18 +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:50 +01:00
tsup.config.ts build: keep preact and the other shared packages external (tsup's noExternal overrode them) 2026-11-09 04:49:15 +01:00
vitest.config.ts fix: add passWithNoTests to vitest config 2026-03-09 03:21:30 +01:00

@quartz-community/darkmode

Adds a dark mode toggle button that switches between light and dark themes.

Installation

npx quartz plugin add @quartz-community/darkmode

It is already included (and enabled) in the default quartz.config.yaml.

Usage

plugins:
  - source: "@quartz-community/darkmode"
    enabled: true
    layout:
      position: left
      priority: 30
      group: toolbar

Configuration

This plugin has no configuration options. To remove the toggle, set enabled: false on its entry.

Documentation

See the Quartz documentation for more information.

License

MIT