Quartz's default remove draft plugin.
  • TypeScript 100%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Emile Bangma 5f7c1f209a
Merge pull request #3 from quartz-community/dev-mode/version-pr-ci
ci: run ci.yml on the changesets version PR and report it as a commit status
2026-11-09 04:01:33 +01:00
.changeset chore: version package 2026-11-08 13:42:36 +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:25 +01:00
src Implement RemoveDrafts filter plugin 2026-02-13 23:27:36 +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: migrate to npm publishing 2026-07-23 09:07:36 +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 23:20:15 +01:00
CHANGELOG.md chore: version package 2026-11-08 13:42:36 +00:00
LICENSE Initial commit 2026-02-13 23:20:15 +01:00
package-lock.json chore: version package 2026-11-08 13:42:36 +00:00
package.json chore: version package 2026-11-08 13:42:36 +00:00
README.md docs: note that this plugin is built into Quartz 5.1+ 2026-11-07 13:15:33 +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 chore: centralize type declarations and standardize tooling config 2026-03-16 18:55:26 +01:00
tsup.config.ts build: bundle dependencies and ship pre-built dist 2026-04-27 21:38:22 +02:00
vitest.config.ts fix: add passWithNoTests to vitest config 2026-03-09 03:21:30 +01:00

@quartz-community/remove-draft

Filters out pages with draft: true in their frontmatter.

Important

Built into Quartz 5.1+. Draft handling is part of Quartz core now, configured under configuration.drafts in quartz.config.yaml — you don't need this plugin anymore. Existing config entries for it keep working (Quartz applies their options to the built-in and doesn't load this package); run npx quartz plugin doctor --fix to update your config. See Built-in processing. This package is kept for Quartz versions before 5.1.

Installation

npx quartz plugin add github:quartz-community/remove-draft

Usage

plugins:
  - source: github:quartz-community/remove-draft
    enabled: true

Configuration

This plugin has no configuration options.

Documentation

See the Quartz documentation for more information.

License

MIT