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.

2.1 – Titles and folder pages

The title of a page

The plugin takes the first value it finds:

  1. navTitle in the frontmatter
  2. title in the frontmatter
  3. the file name without .md — 01 First Steps, not the slug 01-first-steps
  4. the last part of the slug

navTitle is for cases where the page title is too long for a navigation:

---
title: Installing on macOS, Linux and in containers
navTitle: Installation
---

The title of a folder

In the navigation a folder is a node whose link is its folder page (docs/index). Its title comes from:

  1. navTitle in its index.md
  2. title in its index.md
  3. the real directory name — 02 Guides, not 02-guides
  4. the last part of the slug

If there is no index.md, Quartz’s folder-page plugin creates the folder page itself at build time. The folder stays linkable; its title then comes from the directory name.

Folder notes count as folder pages

A file named like its folder (docs/docs.md) and an _index.md already arrive in Quartz as docs/index. For the plugin they are the same as an index.md.

A page and a folder with the same name

about.md next to a folder about/ gives two entries: the page about and the folder about/index. To turn them into one, move the page into the folder as index.md.

Numbers in front of the name

Many vaults sort with numbers: 01 Getting started, 02 Guides. The number decides the order (2.2) — in the title you usually do not want to see it.

options:
  stripNumericPrefix: true

This removes a leading number and the character after it — 01-, 01 , 01_, 01. — from the title. The order stays, because it is read from the file or directory name, not from the title.

It also hits titles from the frontmatter

The number is removed from every title that starts that way, not just from file names. title: 1.2 – Your first navigation becomes 2 – Your first navigation: 1 is the number, . the character after it. That is why this handbook does not switch the option on. The only exception is navTitle — whatever is written there stays as it is.