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.

6.8 – The template package

A template travels as one file with the extension .qtpl. QuartzControl writes it out of a project under Templates (export) and reads it into another one (import). The file is an archive in which twelve parts can lie — each a delimited piece of what makes a project. On import you choose which of them to take over.

The parts

PartWhat it carriesIn this template
Colours & fontsthe nine colour roles for light and dark, the three font roles, where fonts are loaded fromfilled — 6.2, 6.3
CSS variablesyour own values for variables, separately for light and dark66 variables — 6.4
Custom CSScustom.scss and all your own stylesheets with their load order30 stylesheets — chapter 5
Font filesthe font files you brought along and their @font-face rulesfour files, 157 KB — 6.3
Static fileseverything under quartz/static/ except the fonts: logos, images, text snippetstwo snippets — The instances
Layoutwhich component appears where, per page type, and the breakpointsfilled — 1.4
Custom framespage grids you built yourself; registered anew in the target, not copiedfour — 6.5
Pluginsall plugin entries with options, order and positionfilled, among them seven layout boxes — 5.5
Translationstexts changed in Quartz’s language filesfilled, with one limitation (below)
Theme presetssaved combinations of colours and typefacestwo: light and dark
Community themean installed theme with its settingsempty — this template is the theme itself
Contentthe notes themselvesempty — the content lives in the vault

The import shows beforehand which parts the package contains and what in the project is replaced by them, and takes a snapshot — a backup you can return to.

What travels and what does not

Of a project’s files a package carries everything under quartz/styles/ (custom CSS) and everything under quartz/static/ — the font files in a part of their own, logos, images and snippet files in the part Static files.

That the latter exists is new: until 2026-09-06 everything except the fonts stayed behind, and a layout box with file: arrived in the target project pointing at nothing — measured, layout-box-note appeared on 0 of 334 pages. Since then the two snippet files travel along, and in the target project every box renders.

The part counts along with what Quartz brings itself: of the six files under quartz/static/, four are byte for byte Quartz’s own scaffolding (icon.png, og-image.png, two giscus stylesheets) and only the two snippets belong to the template. The preview therefore reports two additions rather than six conflicts, and a target project never gets somebody else’s scaffolding pushed over its own.

Six of the seven layout boxes take their content from the configuration (html:) all the same, and the word mark is an inline SVG. Since 2026-09-06 that is no longer a necessity but a decision: markup inside a config entry cannot arrive without that entry in the first place. The one file: box — “About this handbook” — shows the other way. If its file should be missing after all, that is not an error: the plugin logs a warning and renders nothing; in the dev server a dashed placeholder with the expected path appears.

The content does not travel — on purpose. A template is a design; your own notes come from your own vault. The part Content exists for the rare case of a template that explains itself; this one does that through the vault.

One known limitation

The part Translations does not change component headings

“Backlinks”, “Graph View”, “Recent Notes” come from the plugins themselves, which bring their own language files. What you change in QuartzControl under Configuration → Translations reaches everything the Quartz core labels — not the component headings. Measured on the built page: all three stayed after the change. The mechanism is right; its reach is smaller than you would expect.

Passing the template on yourself

Whoever has changed this template and wants to pass the result on exports a new package under Templates — with the parts that changed. The recipient imports it into their project and chooses the same parts. What they overwrite in doing so, QuartzControl tells them beforehand.

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.