Markdown is a simple markup language you can use to easily add formatting, links, and images to plain text. Markdown is available in the following places:
- Ticket comments (from the agent interface)
- Agent signatures
For agents to use Markdown, an administrator has to enable it in your account. For more information, see Enabling formatting options for agents.
Topics covered in this article:
Adding Markdown to text
The following table shows examples of how you can use Markdown to add common formatting.
You can also watch this short video.
|Formatting||Entered text||Published text|
|Bold||This is how you **bold** text.|
|Italics||This is how you *italicize* text.|
|Bulleted lists||* Bullet one (don't forget a space after the asterisk)
* Bullet two
|Numbered lists||1. Step one
2. Step two
Note: Do not use a hashtag (#) when creating numbered lists in Markdown, as the symbol is used for other formatting.
|Nested lists||* This is the first level of this list.
* To make a second level, add two spaces before the asterisk or number.
Note: You can add things like images, quote blocks, or links to a nested list in addition to just text.
|Headings||# Heading level one (with a space after the #)
## Heading level two
### Heading level three
You can add up to six heading levels.
> Block quotes have to start and end with a blank line
> And each line of the quote starts with a right angle bracket and a space
|Inline code||Here is some `inline code.`|
This is a code block.
Note: Creating a blank line and then indenting the next line or lines with four spaces creates a code block too.
|Images||![Optional alternative text if image doesn't load](http://www.sampleurl.com/logo.png)
Community tip! Evan shares a simple tip in our forums for embedding an image that's not hosted.
|Links||[Link display text](http://www.sampleurl.com)|
|Images that are also links||[![alt text](imageurl)](linkurl)|
|Links to tickets||We addressed this in ticket #61.|
|Horizontal rule line||
Note: You must type a line break before and after the hyphens.
Note: You must type two line breaks before each .
Previewing Markdown in ticket comments
When you use Markdown in a ticket comment, you can preview your formatting before submitting the comment. You enter your comment with Markdown formatting, like in the example below.
Then, click Preview to view how your ticket comment will look when posted.