Advanced Markdown

Additional Markdown syntax is supported to ensure pages can contain additional elements like tables, code blocks and footnotes.

Table of contents

The contents list above is generated automatically. To add a table of contents to a page, add the following Markdown:

[[toc]]

Tables

To add a table, use 3 or more hyphens (---) to create each column’s header, and use pipes (|) to separate each column.

| Syntax    | Description |
| --------- | ----------- |
| Header    | Title       |
| Paragraph | Text        |

The rendered output looks like this:

Syntax	Description
Header	Title
Paragraph	Text

Cell widths can vary, as shown below. The rendered output will look the same.

| Syntax | Description |
| --- | ----------- |
| Header | Title |
| Paragraph | Text |

Alignment

You can align text in the columns to the left, right, or center by adding a colon (:) to the left, right, or on both side of the hyphens within the header row.

| Syntax    | Description | Test Text   |
| :-------- | :---------: | ----------: |
| Header    | Title       | Here's this |
| Paragraph | Text        | And more    |

The rendered output looks like this:

Syntax	Description	Test Text
Header	Title	Here’s this
Paragraph	Text	And more

Fenced code

The basic Markdown syntax allows you to create code blocks by indenting lines by 4 spaces or one tab. If you find that inconvenient, try using fenced code blocks. You can use 3 backticks (```) or 3 tildes (~~~) on the lines before and after the code block.

```
{
  "firstName": "William",
  "lastName": "Pitt",
  "age": 24
}
```

The rendered output looks like this:

{
  "firstName": "William",
  "lastName": "Pitt",
  "age": 24
}

Syntax highlighting

This feature allows you to add color highlighting for whatever language your code was written in. To add syntax highlighting, specify a language next to the backticks before the fenced code block.

```json
{
  "firstName": "William",
  "lastName": "Pitt",
  "age": 24
}
```

The rendered output looks like this:

{
  "firstName": "William",
  "lastName": "Pitt",
  "age": 24
}

Footnotes

Footnotes allow you to add notes and references without cluttering the body of the document.

When you create a footnote, a superscript number with a link appears where you added the footnote reference. Readers can click the link to jump to the content of the footnote at the bottom of the page.

To create a footnote reference, add a caret and an identifier inside brackets ([^1]).

Identifiers can be numbers or words, but they can’t contain spaces or tabs. Identifiers only correlate the footnote reference with the footnote itself — in the output, footnotes are numbered sequentially.

Add the footnote using another caret and number inside brackets with a colon and text ([^1]: My footnote.).

You don’t have to put footnotes at the end of the document. You can put them anywhere except inside other elements like lists, block quotes, and tables.

Here's a simple footnote,[^1] and here's a longer one.[^bignote]

[^1]: This is the first footnote.

[^bignote]: Here's one with multiple paragraphs and code.

    Indent paragraphs to include them in the footnote.

    `{ my code }`

    Add as many paragraphs as you like.

The rendered output looks like this:

Here’s a simple footnote,¹ and here’s a longer one.²

Abbreviations and acronyms

The first time you use an abbreviation or acronym explain it in full on each page unless it’s well known, like UK, DVLA, US, EU, VAT and MP. This includes government departments or schemes. Then refer to it by initials, and use the syntax below so the full explanation is available as hover text.

To create an abbreviation, add an asterisk followed by brackets around the abbreviation and a colon, followed by the explanation (*[UC]: Universal Credit).

You don’t have to put abbreviations at the end of the document. You can put them anywhere except inside other elements like lists, block quotes, and tables.

This policy is the responsibility of the DWP.

*[DWP]: Department for Work and Pensions

This policy is the responsibility of the DWP.

*[DWP]: Department for Work and Pensions

Definition lists

To create a definition list, type the term on the first line. On the next line, type a colon followed by a space and the definition.

First Term
: This is the definition of the first term.

Second Term
: This is one definition of the second term.
: This is another definition of the second term.

The rendered output looks like this:

• First Term: This is the definition of the first term.
• Second Term: This is one definition of the second term.
• Second Term: This is another definition of the second term.

Task lists

Not currently supported

Task lists allow you to create a list of items with checkboxes. To create a checkbox, add brackets with a space ([ ]) at the start of a list item. To show a selected checkbox, add an x in between the brackets ([x]).

1. [x] Write the press release
2. [ ] Update the website
3. [ ] Contact the media

The rendered output looks like this:

1. [x] Write the press release
2. [ ] Update the website
3. [ ] Contact the media

Strike-through

You can strike-through words by putting a horizontal line through the center of them. The result looks like this. This feature allows you to indicate that certain words are a mistake not meant for inclusion in the document. To strike-through words, use 2 tilde symbols (~~) before and after the words.

~~The world is flat.~~ We now know that the world is round.

The rendered output looks like this:

The world is flat. We now know that the world is round.

Highlighted text

To highlight words, use 2 equal signs (==) before and after the words.

I need to highlight these ==very important words==.

The rendered output looks like this:

I need to highlight these very important words.

Inserted text

To indicate inserted text, use 2 plus signs (++) before and after the words. You can use this alongside the syntax for strike-though.

I need to ~~remove~~ ++insert++ a word.

The rendered output looks like this:

I need to remove insert a word.

Subscript

For subscript text, use one tilde symbol (~) before and after the characters.

H~2~O

The rendered output looks like this:

H₂O

Superscript

For superscript text, use one caret symbol (^) before and after the characters.

X^2^

The rendered output looks like this:

X²