2.3 – Hiding and selecting

Hiding here means: not in the navigation. The page is still built and remains reachable through its address, links and search. To not publish a page at all, use Quartz’s own means — draft, ignorePatterns, explicit-publish.

What is missing by itself

What	Option	Default
the 404 page	—	always hidden
the tags folder with the tag pages	hideTags	true
pages marked unlisted by the unlisted-pages plugin	hideUnlisted	true
drafts, draft: true	hideDrafts	true

hideDrafts only matters if drafts reach the build at all. With Quartz’s remove-draft plugin they are gone before that.

navHide — the page decides

---
title: Imprint
navHide: true
---

In an index.md, navHide: true hides the whole folder, with everything in it. The field understands true, false and the words yes/no.

include and exclude — the configuration decides

Patterns on slugs, that is on the path as it appears in the address — without .md, with hyphens instead of spaces.

options:
  exclude:
    - private         # the folder private with everything in it
    - "drafts/**"     # everything below drafts
    - "*/archive"     # any page or folder archive one level deep

Character	Meaning
*	any number of characters within one path segment
**	any number of characters across path segments
?	exactly one character

A folder name hits the whole subtree. It is not just the slug itself that is tested but every folder above it: docs matches docs/index, docs/setup and docs/guides/alpha.

include is the counterpart: if anything is listed there, only what matches stays. exclude is checked first and wins.

options:
  include: [docs]   # a navigation for the documentation only

docs/* takes the folder with it

* matches every child of docs — including index, and through the folder check everything below. Nothing is left, and the empty folder drops out. Hiding just the folder page (exclude: ["docs/index"]), on the other hand, keeps the folder: it then links to its first page (3.3).

Empty folders

Whatever is left after hiding gets tidied up:

Option	Default	Effect
hideEmptyFolders	true	folders without visible children drop out
keepIndexOnlyFolders	true	… unless they have a folder page of their own

Because folder-page creates a page for every folder, a folder whose pages are all hidden stays with the defaults — as a link to its folder page. If you do not want that, set keepIndexOnlyFolders: false. The root never drops out.