Quartz's default explicit publish plugin.
  • TypeScript 100%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-10 00:00:18 +01:00
.changeset chore: version package 2026-11-09 22:59:26 +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 feat: publish files without frontmatter that published pages link to (bases-page#11) 2026-11-09 04:32:20 +01:00
test feat: publish files without frontmatter that published pages link to (bases-page#11) 2026-11-09 04:32:20 +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:04 +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:36 +01:00
CHANGELOG.md chore: version package 2026-11-09 22:59:26 +00:00
LICENSE Initial commit 2026-02-13 23:20:36 +01:00
package-lock.json chore: version package 2026-11-09 22:59:26 +00:00
package.json chore: version package 2026-11-09 22:59:26 +00:00
README.md docs(readme): Quartz 5.1 — npm install and config, correct options and defaults 2026-11-09 22:57:48 +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 feat: publish files without frontmatter that published pages link to (bases-page#11) 2026-11-09 04:32:20 +01:00
tsup.config.ts build: bundle dependencies and ship pre-built dist 2026-04-27 21:37:49 +02:00
vitest.config.ts fix: add passWithNoTests to vitest config 2026-03-09 03:21:30 +01:00

@quartz-community/explicit-publish

Only publishes pages that have publish: true in their frontmatter.

Installation

npx quartz plugin add @quartz-community/explicit-publish

The default quartz.config.yaml already lists this plugin, disabled. Set enabled: true to turn it on.

Usage

plugins:
  - source: "@quartz-community/explicit-publish"
    enabled: true

Files without frontmatter

.base, .canvas and .excalidraw files have no frontmatter to put publish: true in. They are published along with the published pages that link to them ([[Board.canvas]], or an embed that needs the file's page, such as ![[Board.canvas]]), and not otherwise — like Obsidian Publish adding the files a published note links to. A file that only unpublished notes reference, or that nothing references, is not published. A base embedded in a published note (![[Views.base]] or a ```base block) renders inside that note without getting a page of its own.

A drawing stored as Markdown (.excalidraw.md) has frontmatter, and follows its own publish: like a note. This needs Quartz 5.1 or later, which runs the filters on these pages.

Images and other files are copied to your site whether or not a published page uses them. Set configuration.publishAssets: referenced to only publish the files that published pages link to or embed.

Configuration

This plugin has no configuration options.

Documentation

See the Quartz documentation for more information.

License

MIT