Markdown guide

Last updated 07/01/2016

When you write an update it can be formatted using Markdown.

Bold text

Mark text in double asterisks or underscores, like **this** or __this__, to make it bold.

Italic text

Mark text in single asterisks or underscores, like *this* or _this_, to make it italic.

Bullet point (unordered) list

Prefacing a line of text with a hyphen or asterisk will create an unordered list. For example:

- Item 1
- Item 2

* Item 1
* Item 2

Numbered list

Prefacing a line of text with a number will create an ordered list. For example:

1. Item 1
2. Item 2

Create a link by putting the link text in brackets and the URL in parentheses, like [this](http://www.heyupdate.com).

Code block

Include formatted code by wrapping it in three backticks (```) at the beginning and end of the block. Note that the triple backticks have to be on a separate line and ensure you have a blank line before and after the code block.

Inline code

Include inline formatted code by wrapping it in a single backtick (`) at the beginning and end of the code.

Indent text

Indent text by including a “>” in front of each line of the text that you’d like to indent.

Unsupported features

There are some features that we see as unnessacary for short updates so have ommitted from the Markdown processor. These are:

  • Headers
  • Horizontal line
  • HTML