Wiki syntax

The site uses Pandocs Markdown. A short summary of the most commonly used syntax follows.

Basics

This is how you write bold or emphasised words, code and external links and internal links.

  • list
  • items
term
definition

Headers

Headers can have custom #anchors like so:

Headers without an explicit anchor gets one generated based on the header text itself (i.e. for use in the table-of-contents).

Page title and metadata

Each page should have a header block containing at least a title for the page, that also shows up as the first header on the page.

Alternatively, a YAML metadata block can be used to set more kinds of metadata and processing instructions.

Code blocks

Often docs need to show some example Lua code, which is done using code blocks like this: