3.2 – Levels and headers

depth — how deep

options:
  depth: 1   # 0 = unlimited (default)

Counted from the chosen folder (3.1): depth: 1 shows only its children, depth: 2 their children too. Folders at the limit appear as a link without expanding.

The usual values:

Where	depth
menu bar bar	1
dropdown	2 — first level in the bar, second in the menu
mega	3 — bar, column headings, entries
sitemap columns	2
sidebar tree, accordion	0

depth also applies to select and pager: a pager with depth: 1 only pages through the first level.

hideOutsideRoot — where it hides itself

Only effective with rootPath. With the default true, the navigation appears only on the folder page of rootPath and on pages below it.

options:
  rootPath: docs
  hideOutsideRoot: false   # the docs navigation on the blog too

false is right for a footer sitemap that should show the same subtree everywhere. true is right for anything that only makes sense in one section. One navigation per language needs no rootPath for that (8.3).

showScopeRoot — a header

options:
  scope: section
  showScopeRoot: true

Above the list sits the shown folder itself, as a link. With scope: section that is the name of the section — “1 – Getting started” above the pages of the first chapter, as on the right of this page. Where the link points is decided by folderLink (3.3).

showHome — a “Home” entry

options:
  variant: bar
  depth: 1
  showHome: true

The first entry of the list leads to the folder page of rootPath, without rootPath to the start page. It is labelled “Home” (or “Start”, depending on the language — 7.3), in the vertical variants with a house in front. It only appears if that page exists, and never with tabs.

indexEntry — an “Overview” row

options:
  variant: accordion
  indexEntry: first

Every folder whose children are shown and which has a folder page gets the entry “Overview” as its first child, leading to that page.

This is needed when the folder row itself is not a link: with the default folderClick: toggle a click on the row only expands the folder (5.1). Without indexEntry the folder page would then be unreachable from this navigation.