Zendesk Markdown Examples

Markdown can be used by agents in ticket comments, in macros, and in your agent signature. You add Markdown formatting as plain text and can then preview it before saving the comment (via submitting a ticket update).

Bold and italic

The asterisk character (*) is used for both italic and bold emphasis.

*I will display in italics*
**While I will display in bold**

You also use the underscore (_) character.

_I will display in italics_
__While I will display in bold__

Lists

You can create both ordered and unordered lists. Lists must begin and end with a blank line.

Unordered lists can begin with either an asterisk or a plus or minus sign, followed by a space.

* Item 1
* Item 2
* Item 3

+ Item 1
+ Item 2
+ Item 3

- Item 1
- Item 2
- Item 3
Each option (asterisk, plus, or minus sign) renders as an <ul> tag in HTML:
                         
                         <ul> 
<li>Item 1</li>
<li>Item 2</li>
<li>Item 3</li>
</ul>

You create numbered lists using a number and a period followed by a space. The numbers you use are unimportant because any combination will render as a <ol> tag and properly number the items in the list. So, either of these examples will work:

1. Item 1
3. Item 2
100. Item 3

1. Item 1
1. Item 2
1. Item 3

You can nest lists by adding two spaces at the beginning of the list items. You can only nest lists one level down.

* Level 1
* Level 1
      * Level 2
      * Level 2
* Level 1
* Level 1

Block quotes

Quotes are created using the right arrow character (>) and a space, which you add before each line of the quote. The quote must begin and end with a blank line. How you break the quote into separate lines is up to you.

> Quoting people is easy, you simply put a > before each line > of the text you want to quote

Inline code and code blocks

To format code inline, you use the following:

`codeIsAwesome()`

Code blocks are formatted like this:

``` Code blocks are great for display large amount of code that need to maintain whitespace and indenting ```

A code block must begin and end with a blank line. Within the code block itself, you use spaces to indent your lines of code.

Images and links

To add images, you link to images to you have hosted somewhere on the internet using this formatting:

![I am an image's alt text](http://www.example.com/image.png)

The alt text is not required, so you can also do this:

![](http://www.example.com/image.png)

Links use a similar syntax, but the exclamation point (!) is not used. The link text is contained in brackets and the link itself in parenthesis.

[I am the text to be linked](http://www.example.com)
Note: We still auto link URLs, so there's no need to write something like this:
[http://www.example.com](http://www.example.com)

Headings

Heading levels are expressed using the hash character (#) followed by a space.

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
You must add blank lines above and below each heading.

# Heading 1

 

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.