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.

2 – Formatting

Notes in Obsidian are Markdown: text with a few characters in it that carry meaning — two asterisks for bold, a hash for a heading, square brackets for a link. Quartz reads these characters and makes the page from them. This chapter shows every element you can write this way on a short page of its own: first the source in a code block, directly below it what the site makes of it.

For copying

The box at the top of every page is exactly what you type in Obsidian. Whoever wants to rebuild an element copies it — and compares the result with the one below.

The thirteen sections

SectionWhat is in it
2.1 – Textbold, italic, strikethrough, highlighted, special characters, line breaks
2.2 – Structureheadings, paragraphs, horizontal rules
2.3 – Listsunordered, ordered, tasks, nesting
2.4 – Linkswikilinks, jump targets, external links, aliases, embeds
2.5 – Calloutsall thirteen types, foldable, nested
2.6 – Codeinline, blocks, languages, line highlighting
2.7 – Tablesbasic form, alignment, cell contents, wide tables
2.8 – Mathematicsformulas inline and as a block
2.9 – DiagramsMermaid: fourteen kinds of diagram on six pages
2.10 – Footnotesfootnotes, variants, comments
2.11 – Propertiesfrontmatter, data types, display
2.12 – Mediaimages, sizes, video, audio, documents, embeds
2.13 – Odds and endsHTML, escapes, arrows, emoji

What is not a Markdown page — bases, canvas and Excalidraw — stands in 3 – Obsidian formats. What a page’s frontmatter does — draft, date, alias, cover image — stands in 4 – Controlling a page.

What Obsidian can do and Quartz cannot

Obsidian and Quartz speak almost the same language, but not quite. These deviations were measured on the built site; the linked page shows in each case what works instead.

In ObsidianOn the siteWhere it stands
Tasks with intermediate states ([/], [-], [?])only open and done; any other character becomes an empty boxTask lists
Inline footnote ^[text]stays as raw textNamed and repeated footnotes
Arrows like --> become →stay raw text; with GitHub flavored markdown they turn into —>Arrows, tags and emoji
A tag in running textits link leads out of the site — a bug in QuartzArrows, tags and emoji
Image with a size and an alt textonly one of the twoImages
Embedded PDF from page 2always starts on page 1Documents
Definition listsexist in neither; HTML steps inHTML in Markdown

On top of that comes what deliberately looks different on this site than in Quartz out of the box — the callout colours, for instance. That does not stand here but in 5 – The design with the component in question.

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.