Writing for the site

Everything on this site — Blog posts and Wiki pages alike — is written in Markdown in the admin dashboard. This note is the reference for the formatting that’s available.

Handbook chapters and notes#

• Handbook chapters form an ordered book. Set a part (such as “Foundations”) on top-level chapters to group them, and a position number to order them — gaps like 10, 20, 30 make it easy to insert chapters later. Choose a parent chapter to make a section; numbers like 2.1 are assigned automatically.
• Notes are standalone articles. Give them tags: readers can filter notes by tag, and each note lists related notes that share one.

Text#

Use ## for section headings and ### for subsections; they appear in the page’s table of contents. Footnotes are written [^1] in the text and [^1]: … at the end.¹

Mathematics#

Inline maths goes between single dollar signs: $E = mc^2$ renders as E = mc^2. Display equations go between double dollar signs on their own lines:

$$
\nabla \cdot \mathbf{v} = 0
$$

which renders as

Write \$ for a literal dollar sign. A lone amount such as $5 is left alone automatically.

Figures#

Upload images with the image button in the editor, or drag them into the text. An image on its own line becomes a figure, and its title becomes the caption:

![Street network of the study area](/uploads/streets.png "Figure 1. Street network of the study area.")

Figures, tables, code and equations use the same width as the text, so everything lines up.

Call-outs#

!!! definition "Spatial token"
    A discrete unit of geographic space that a model reads as input.

renders as

The available types are note, tip, warning and definition.

Code and tables#

Fence code with three backticks and a language name for syntax highlighting. Tables use pipes, with a row of dashes under the header. Raw HTML is allowed too, for example to embed a video with an <iframe>.