English
About this handbook

This handbook belongs to the template Example for QuartzControl. It explains the template and, at the same time, shows everything it can do.

The text here comes from a Markdown file, not from the configuration.

Embedding a page

An exclamation mark in front of the wikilink embeds the content instead of linking to it.

![[en/2-formatting/02-structure/horizontal-rules]]

Horizontal rules

---

Three hyphens on a line of their own. The rule separates sections that do not deserve a heading of their own.

Careful at the start of a file

Three hyphens at the very top of the file open the frontmatter, not a rule. Anyone wanting to begin a page with a rule puts a paragraph in front of it.

In this template

The rule is a hairline in --tpl-rule with generous space above and below (--tpl-space-xl). Out of the box Quartz draws a heavier line with less air.

Zur vollständigen Seite

Only one section

![[en/2-formatting/04-links/wikilinks#Short form]]

Short form

As long as the file name is unique within the vault, it is enough on its own:

[[headings]]

headings

The Crawl links plugin resolves the path at build time. This template runs on markdownLinkResolution: shortest — the shortest unambiguous notation wins.

Two languages, two file names

This is one reason the English pages carry English file names: headings finds the English page, ueberschriften the German one. Had both languages used the same names, the short form would have become ambiguous — see Two languages.

Zur vollständigen Seite

Only one block

With the block identifier from Jump targets:

![[en/2-formatting/04-links/targets#^keypoint]]

This paragraph has an identifier.

Zur vollständigen Seite

That is the finest step: a single paragraph instead of a whole page or a section.

An image from outside

A URL can be embedded too:

![Description](https://example.com/image.png)

That loads from a foreign server on every page view. For a site meant to work offline and in ten years’ time, the file in the vault is the better choice.

What this template does differently

An embedded page gets a dashed bar on the left and a tinted surface — you should see where foreign content begins and ends. Out of the box the embed is not visually separated from the surrounding text.

Careful with chains

If the embedded page embeds something in turn, the page quickly becomes hard to follow — and a circle (A embeds B, B embeds A) is an error that only the build reveals.

An embed brings its heading ids along

Unchanged, at that. Quartz builds a heading’s id from its text — “In this template” becomes in-this-template — and does not check on embedding whether the target page already has it. If a heading of the embedded page is called the same as one of the embedding page, two elements carry the same id.

That is exactly what stood on this page until 2026-09-10: the embedded opening carries “In this template”, and so was the last section here called. Measured on the built page, that had three consequences:

  • The link in the table of contents jumped to the first of the two — to pixel 1005 instead of 2681. On a duplicate id a browser always takes the first.
  • The last entry of the outline was already marked at the very top. The plugin’s script maps a heading to its entry through the id; both headings therefore pointed at the same entry, and it obeyed whichever stood higher up.
  • The progress bar consequently had a hole: halfway down, the first, second and fourth entries were marked and the third was not.

It can only be fixed where the ids are made. What helps here is renaming the heading — which is why the section above is called “What this template does differently” and not what the rest of this chapter calls it. Whoever embeds a whole page does well to check once whether two headings get in each other’s way.

Read on

This page belongs to Example — the example template for QuartzControl. An overview of every area is on the English home page.

On a narrow screen the navigation is collapsed at the top.