Examples
Worked front matter, one page per topic.
How to configure the three formats, write the components, and organise a document, with one page for each group of options.
The rendered report on this site is built by the format as the site is published.
An option belongs in one of three places.
- A format option goes under
format: mcanouil-html:,mcanouil-typst:, ormcanouil-revealjs:. - A document option goes under
extensions: mcanouil:. - A block attribute goes on the element itself.
The pages
| Page | What it covers |
|---|---|
| Components | The divider, value-box, progress, and badge shortcodes, and the colour and icon values they accept. |
| Containers | Panels, cards, highlights, and the executive summary, and the two ways a card gets a footer. |
| Special sections and tabsets | What the Typst filters move, renumber, and unwrap. |
| HTML format | The layout style, the title block groups, and where each default comes from. |
| Typst format | Document types, page decoration, section pages, and sending a class to a Typst function. |
| Reveal.js format | Section outlines, ordinal dates, and the two options for laying a deck out. |
| Code windows | Window chrome per project and per block, and the three Typst hot-fixes. |
A website
project:
type: mcanouilThe project type supplies a branded navbar, a page footer, and a favicon, and it sets mcanouil-html as the default format, so a site needs nothing else to be branded.
It also supplies a value for several document options. A standalone document has no project type, so some of its options resolve differently, which HTML format sets out.
Source
The repository ships a starting point you can copy: example.qmd.