Skip to content

Markdown

Several fields in the admin, such as a booking type or add-on description, accept Markdown: a simple way to format text by typing a few plain characters. You write it in the field, and it is shown to attendees with the formatting applied. You do not need to know it all; a description works fine as plain text, and you add formatting only where it helps.

The most common formatting is:

To get this Type this
Bold **bold**
Italic *italic*
A link [link text](https://example.com)
A heading ## Heading
A bullet list - item on each line
A numbered list 1. item on each line
A quote > quoted text

Leave a blank line between paragraphs to keep them apart.

For anything beyond this, see a full reference such as the Markdown Guide. We do not repeat the whole of Markdown here.

On top of standard Markdown, our fields also understand a few widely used extras. These are the ones worth knowing:

  • Tables, written with pipes and dashes:

    | Day | Time |
    |----------|-------|
    | Friday | 6pm |
    | Saturday | 9am |
  • Strikethrough, by wrapping text in double tildes: ~~no longer available~~.

  • Task lists, using - [ ] for an empty box and - [x] for a ticked one.

  • Automatic links: a plain web address becomes a clickable link on its own, without the [text](link) form.

You can also include images in these fields, and a limited amount of HTML for cases Markdown does not cover.

In particular, you can wrap content in <div> or <span> tags and give them a class or id:

Members <span class="member-price">save 20%</span> on every ticket.

The class and id carry through to the page, so you can target that content from your custom theme styles (for example, styling .member-price) to give certain content its own look across your site. This is the main reason to reach for HTML here: use a div or span with a class when you want your theme’s styling to hook onto specific content. Where plain Markdown can do the job, prefer it; it is simpler and more predictable.