Markdown

CommonMark, via comrak, with a set of extensions on by default. Each is a key under [markdown] in sqzass.toml.

[markdown]
footnotes             = true
tables                = true
tasklist              = true
strikethrough         = true
autolink              = true
alerts                = true
cjk_friendly_emphasis = true
heading_anchors       = "right"   # none | left | right

Alerts#

GitHub's callout syntax, built on blockquotes:

> [!NOTE]
> The static Linux build ships the pure-Rust regex engine.

NOTE, TIP, IMPORTANT, WARNING and CAUTION are recognised.

Tables#

| Key | Default |
|---|---|
| `output_dir` | `public` |

Key	Default
output_dir	public

Task lists#

- [x] Search
- [ ] Feeds

• Search
• Feeds

Footnotes#

Text with a note¹.

Text with a note[^1].

[^1]: The note itself.

Headings#

Every heading gets an id, whether or not anchors are shown, because the table of contents and any deep link you hand out both depend on it. Repeated headings get -1, -2 suffixes, and the anchor and the contents entry are guaranteed to agree — they come from the same counter, in one pass.

heading_anchors controls the visible # link: "right" (default), "left", or "none".

Two settings that are not keys#

Both are fixed, and both are deliberate — this section exists so that looking for the option and not finding it ends here rather than in an issue.

Raw HTML always passes through. Content is trusted: it is in your repository, written by you, reviewed in the same commit as the code. Sanitising it would be theatre. If sqzass ever ingests untrusted markdown, that becomes a per-source trust level rather than a global switch.

Code fences produce <code class="language-rust">, not <pre lang="rust">. The class form is what every client-side highlighter and every copy-button snippet expects.

Code#

Highlighted at build time into CSS classes. See Syntax highlighting.

1. The note itself. ↩