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.

9.2 – Messages

All messages start with [navigations] and appear once per cause, not once per page. None of them stops the build: the plugin takes the default or leaves out what is broken and keeps building.

Unknown value "…" for `…`; using `…`.

A value the option does not know — a typo, a German spelling (variant: baum), a value from another option. The named default applies. The allowed values are in 9.1.

`…` must be an integer >= …; using ….

depth or columns.max is not an integer, or too small. depth: "2" in quotes works; depth: 1.5 and depth: -1 do not.

Ignoring invalid `…` entry …

An entry in include, exclude or an order list is not text or is empty. Only that entry is dropped.

`order` must be a map of folder → list. · `nodeIcons` must be a map of path → icon.

The option is a list instead of a map. Correct:

order:
  docs: [intro, setup]
nodeIcons:
  docs: lucide:book-open

Ignoring invalid `nodeIcons` entry for "…".

The value for this path is empty or not text.

`order` for "…" lists unknown entry "…".

A folder’s order list names something that does not exist in it — usually a renamed file, or a slug instead of a file name with different spelling. The other entries still apply. See 2.2.

`rootPath: …` is not a folder with visible pages.

The folder does not exist, rootPath names a page instead of a folder, or everything in it is hidden — by exclude, navHide, drafts. The navigation appears on no page.

`language: …` matches no page language (…).

The fixed language matches none of the languages quartz-multilanguage recorded on the pages; the parentheses list the ones that exist. Usually a typo, or a language that has no page yet. The navigation appears on no page (8.3).

Unknown Lucide icon `…`; see https://lucide.dev/icons

A name from navIcon, nodeIcons or iconNames is not in the Lucide set. No icon appears there. Common causes: a name from an older Lucide version (home is house today), or with iconNames a superfluous lucide: in front.

Could not read quartz/styles/variables.scss; using 800px / 1200px as breakpoints.

The build is not running in the project folder, or the file is missing. The navigation switches to mobile at 800 pixels (6.2).

`variant: vertical` is now `tree`. · `dropdownTrigger` is now `trigger`.

Old spellings from version 0.1. They still work; the message goes away as soon as the new spelling is used.

`style` was removed; …

The style option no longer exists and is skipped. Styling is done through the CSS variables (7.2).

When nothing happens at all

No message, no navigation — then it is rarely the plugin:

CauseWhat helps
enabled: falseswitch it
The scope is empty on this pagecheck scope, rootPath, hideOutsideRoot (3.1)
The pager has no neighboursthe page is hidden, or it is the only one in the scope
The navigation sits in an unexpected placelayout block missing — then left, priority: 10