Quartz's default unlisted pages plugin.
  • TypeScript 100%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
2026-11-10 00:03:15 +01:00
.changeset chore: version package 2026-11-09 23:02:23 +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:27 +01:00
src feat: unlisted applies to pages rendered from files with frontmatter (bases-page#11) 2026-11-09 04:32:20 +01:00
test feat: unlisted applies to pages rendered from files with frontmatter (bases-page#11) 2026-11-09 04:32:20 +01:00
types Initial commit 2026-04-11 14:30:54 +02:00
.eslintrc.json Initial commit 2026-04-11 14:30:54 +02:00
.gitignore chore: migrate to npm publishing 2026-07-23 09:07:51 +02:00
.prettierignore Initial commit 2026-04-11 14:30:54 +02:00
.prettierrc Initial commit 2026-04-11 14:30:54 +02:00
CHANGELOG.md chore: version package 2026-11-09 23:02:23 +00:00
LICENSE Initial commit 2026-04-11 14:30:54 +02:00
package-lock.json chore: version package 2026-11-09 23:02:23 +00:00
package.json chore: version package 2026-11-09 23:02:23 +00:00
README.md docs(readme): Quartz 5.1 — npm install and config, correct options and defaults 2026-11-09 22:57:51 +01:00
tsconfig.build.json Initial commit 2026-04-11 14:30:54 +02:00
tsconfig.json Initial commit 2026-04-11 14:30:54 +02:00
tsup.config.ts build: bundle dependencies and ship pre-built dist 2026-04-27 21:38:37 +02:00
vitest.config.ts Initial commit 2026-04-11 14:30:54 +02:00

@quartz-community/unlisted-pages

Zero-config transformer that bridges frontmatter.unlisted to file.data.unlisted so any page can opt out of discovery surfaces while remaining accessible by direct URL.

What it does

Quartz v5 plugins that respect the file.data.unlisted convention — Quartz's built-in content index, search, backlinks, recent-notes, folder-page, and tag-page — will hide a page from their output when file.data.unlisted === true. But nothing in the core pipeline copies frontmatter.unlisted onto file.data.unlisted, so a user writing:

---
title: My Draft
unlisted: true
---

gets no effect. This plugin fixes that. It is a trivially small rehype plugin that does one thing: if frontmatter.unlisted is a boolean, copy it to file.data.unlisted.

With Quartz 5.1 it also runs on pages rendered from files that have frontmatter (through virtualPageHtmlPlugins), such as Excalidraw drawings stored as Markdown (.excalidraw.md): unlisted: true there unlists the drawing like a note.

Installation

npx quartz plugin add @quartz-community/unlisted-pages

It is already in Quartz's default configuration.

Usage

Add an unlisted field to any page's frontmatter:

---
title: My Draft
unlisted: true
---

When registered, this plugin marks the page as unlisted. Every Quartz v5 plugin that respects the convention will then hide it:

  • Absent from contentIndex.json, sitemap.xml, the RSS feed, backlinks, recent notes, folder listings, tag listings, graph, explorer, and search.
  • Still emitted as HTML, so the page remains accessible by direct URL.

Configuration

Zero options. Just enable it.

- source: "@quartz-community/unlisted-pages"
  enabled: true
  order: 45

Interaction with @quartz-community/encrypted-pages

The encrypted-pages plugin also sets file.data.unlisted when unlistWhenEncrypted: true or when per-page frontmatter specifies unlisted: true. The two plugins compose cleanly:

  • If you install only unlisted-pages: any page with unlisted: true in frontmatter is hidden from listing surfaces. Encryption is independent.
  • If you install only encrypted-pages: unlisted: true only works on pages that are ALSO encrypted (have a password). Non-encrypted pages with unlisted: true are silently ignored.
  • If you install both: unlisted: true works for every page, encrypted or not. This is the recommended setup for sites that use encrypted pages.

How unlisted works across consumer plugins

Plugin Behavior when file.data.unlisted === true
Content index (built into Quartz) Page absent from contentIndex.json, sitemap.xml, and the RSS feed.
search Page absent from search results (derived from contentIndex.json).
graph Page absent from graph nodes and edges (derived from contentIndex.json).
explorer Page absent from the sidebar file tree (derived from contentIndex.json).
backlinks Page never appears as a backlink source on other pages.
recent-notes Page absent from the recent notes list.
folder-page Page absent from folder listings and folder discovery.
tag-page Page absent from tag listings and tag discovery.

In every case, the page's HTML is still emitted and accessible by direct URL.

API

  • Category: Transformer
  • Function name: ExternalPlugin.UnlistedPages()
  • Source: quartz-community/unlisted-pages
  • Install: npx quartz plugin add @quartz-community/unlisted-pages (included in the default configuration)
  • Documentation: UnlistedPages

License

MIT