UnlistedPages

summary:

• Zero-config transformer.
• Honors unlisted: true frontmatter.
• Emits HTML; preserves direct URL access.
• Removes page from:
  • contentIndex.json
  • RSS
  • sitemap
  • graph
  • explorer
  • search
  • backlinks
  • recent notes
  • folder listings
  • tag listings

Note

Plugin management: Configuration.

Usage

frontmatter:

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

effect:

• Hides the page from Quartz v5 plugins that respect file.data.unlisted.

Plugin effects

Plugin	Behavior when unlisted: true
ContentIndex	Removed from contentIndex.json, sitemap.xml, and RSS feed.
Search	Removed from search results (via contentIndex.json).
Graph	Removed from graph nodes and edges (via contentIndex.json).
Explorer	Removed from sidebar file tree (via contentIndex.json).
Backlinks	Hidden as a backlink source.
RecentNotes	Removed from recent notes list.
FolderPage	Removed from folder discovery and listings.
TagPage	Removed from tag discovery and listings.

direct_access:

• HTML emitted.
• Direct URL access retained.

Configuration

options:

• None.

quartz.config.yaml

- source: github:quartz-community/unlisted-pages
  enabled: true

Interaction with EncryptedPages

mechanic:

• EncryptedPages also sets file.data.unlisted when:
  • unlistWhenEncrypted: true
  • unlisted: true exists in frontmatter

scenarios:

• UnlistedPages only:
  • unlisted: true hides any page.
  • Encryption independent.
• EncryptedPages only:
  • unlisted: true hides encrypted pages only.
  • Non-encrypted pages ignore unlisted: true.
• Both installed:
  • Recommended.
  • unlisted: true hides any page: encrypted or unencrypted.

API

api:

• Category: Transformer
• Function name: ExternalPlugin.UnlistedPages()
• Source: quartz-community/unlisted-pages
• Install: npx quartz plugin add github:quartz-community/unlisted-pages