English
About this handbook

This handbook belongs to the Quartz plugin quartz-navigations. And it is built with it: the menu above and the previous/next links below every text come from there.

What the entries behind them look like is explained in 8.1.

3.3 – Where folders link

options:
  folderLink: index   # index | first-child | none
ValueA folder title leads to …
index (default)its folder page; if there is none, its first page
first-childits first page, even if it has a folder page
nonenothing — the title is text

The first page

“First page” means: the first entry in tree order (2.2) that is a page. If a subfolder is there, the plugin keeps looking inside it — unless it has a folder page of its own, in which case that is the first page.

first-child suits folders that are only structure: a click on “Guides” lands directly on the first guide instead of an overview that has nothing to say.

Are there folders without a page at all?

Rarely. Quartz’s folder-page plugin creates a page for every folder, even without index.md. The fallback of index to the first page only applies when folder-page is switched off — or when the folder page was hidden, for instance with exclude: ["docs/index"].

What the other variants make of it

VariantFolder without link target (none)
lists, bars, menustitle as text
selectoption cannot be selected
pagerskipped

And one peculiarity of the pager: if a folder and its first page lead to the same address, it pages there only once. A “Previous” that points at the page you are on does not exist.

Folders that expand

In accordion, flyout, dropdown and mega a folder is more than a title — it expands. Whether its row then expands or links is decided by a second option, folderClick (5.1). folderLink only says where a link leads, if there is one.