Markdown is a simple markup language you can use to easily add formatting, links, and images to plain text. You can use it in the following places:
- Ticket comments (from the agent interface)
- Macros
- Agent signatures
- Dynamic content
- Content blocks in help center articles
Markdown commands are automatically supported by your ticket editor. You can enter Markdown comments to format your content, or you can use the format toolbar to add rich content. See Table 1 below for supported Markdown commands.
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 don't need to preview your formatting. Your content is formatted automatically as you enter Markdown commands.
You can also watch this short video.
Formatting | Entered text | Published text | Comments |
---|---|---|---|
Bold | This is how you **bold** text. | ![]() |
Supported |
Italics | This is how you *italicize* text. | ![]() |
Supported |
Bulleted lists | * Bullet one (don't forget a space after the asterisk)
* Bullet two You must type a line break before and after the list. |
![]() |
Supported. You can also start with a hyphen (-) followed by a space to create a bulleted list. |
Numbered lists | 1. Step one
2. Step two Do not use a hashtag (#) when creating numbered lists in Markdown, as the symbol is used for other formatting. You must type a line break before and after the list. |
![]() |
Supported |
Nested lists | * This is the first level of this list.
You can add things like images, quote blocks, or links to a nested list in addition to just text. You must type a line break before and after the list. |
![]() |
Supported, except for content blocks. For the second level of indent, press Tab after the bulleted list or numbered list. |
Headings | # Heading level one (with a space after the #)
## Heading level two ### Heading level three |
![]() |
Supported. Up to four heading levels. Up to six heading levels in content blocks. |
Block quotes |
> 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
|
![]() |
Supported |
Inline code | Here is some `inline code.` | ![]() |
Supported |
Code blocks | ```
This is a code block. ``` Creating a blank line and then indenting the next line or lines with four spaces creates a code block too. You must type a line break before and after the code block. |
![]() |
Supported. To exit a code block placed at the end of a comment, press the Return key three times in a row. |
Images | ![Optional alternative text if image doesn't load](http://www.sampleurl.com/logo.png)
Tip: To embed an image that's not hosted, first attach the image to the ticket. Then open the attachment, right-click the image, select Copy image URL, and use this link to embed your image. Doesn't work if private attachments are enabled.
|
![]() |
Supported, except for content blocks. Adding an image URL automatically turns it into an image link. When the ticket comment is submitted, the image appears in the conversation log.* |
Links | [Link display text](http://www.sampleurl.com) | ![]() |
Supported in agent signatures* |
Images that are also links | [![alt text](imageurl)](linkurl) | ![]() |
Supported in agent signatures* |
Links to tickets | We addressed this in ticket #61. | ![]() |
Not supported, yet |
Horizontal rule line |
--- You must enter a line break before and after the hyphens. If you have three or more dashes under a line of text, with no blank space between them, instead of creating a horizontal rule below the text, the text above will change into a header. |
![]() |
Supported |
Line break |
Line 1 Line 2 You must type two line breaks before each . |
Line 1
Line 2 |
Not supported, except for content blocks. In content blocks, type Shift+Enter to add a line break. |
Underscore | This is how you \_underscore\_ text. | This is how you underscore text. | Supported only in content blocks. |
* When you enter URLs for links and images, make sure you include the full URL, including the http:// or https:// prefix. |
Pasting Markdown text from another source
Here are some things to consider when you copy Markdown text from another source and paste it into the ticket composer:
- If you copy text with Markdown commands from a plain text editor, the content is automatically formatted as soon as you paste it. If you don't want the content to be automatically formatted, use Cmd+Shift+V (Mac) or Ctrl+Shift+V (Windows) to paste.
- If you paste text with Markdown commands from a rich text editor, the Markdown commands remain "as is". The content is not automatically formatted.
- If you copy text with Markdown commands from any type of editor into a code block in the ticket composer, the content is not automatically formatted. It remains "as is."
- If you paste Markdown text with code blocks or nested lists, the format is not automatically carried over into the ticket composer.
74 comments
Agis Kalogiannis
Hi. I wanted to know if there are any other more advanced options for formatting. Like Drop down menus, accordions or divs that would allow multiple columns in a document.
Thanks
2
Rosie
This is actually a good advanced options in formatting. But it doesn't sound like this functionality is currently on our roadmap. Can you please share your feedback in our Community? So we can get some traction from our product team? I recommend posting this on our Product Feedback Page - https://support.zendesk.com/hc/en-us/community/topics/1260801325369.
You may also want to follow our this section for any new features and updates to our product https://support.zendesk.com/hc/en-us/sections/200623776-Announcements and follow this article to keep you notified of any changes.
Thank you!
0
Henry Walkley
Hello!
Please can I ask if there is strikethrough? Is that something set at Zendesk level or can I control formatting as as Admin?
Are there plans to add extra formatting or is the above list totally exhaustive?
Many thanks!
~~does not work~~
<del>does not work</del>
0
James G
Unfortunately, this is not supported yet. Here's a previous comment for reference as well - https://support.zendesk.com/hc/en-us/articles/4408846544922/comments/4408851314202
0
Olli
Trying to underscore text with markdown.
It doesn't work.
_underscore_ turns into italics
\_underscore\_ does nothing
How do we underscore text? We need to do it via dynamic content. We test it by typing the markdown in the compose message window. Both with the mentioned outcome.
Thanks
Oliver
0
Curt Kempf
Oliver, did you try this in content blocks?
![](/hc/user_images/01HQX5WPPNJFWP0QX72R9PAB3N.png)
0
Olli
Yes. We tried in Dynamic content and in the agent form. Outcome as mentioned above.
Also, very honestly, it doesn't make sense to have _ _ as italics and also ** ** as italics.
Google search for general markdown syntax brings the result that "there is no underline in markdown", but I wonder how Zendesk came up with that suggestion you mention, Curt Kempf
We go with italics now and stop twisting our minds about it ;)
Best regards
Oliver
0
Mike DR
Have you tried using the underline button in the editor?
0
Deme Shor
I'm able to get the insert image and insert link markup to work in the comment field, but not the one to make an image a link despite it just being those two together. When I attempt it the image automatically displays and that's…it. The URL appears as a link next to it, but I've tested sending it just to see w/no luck.
Here's how I entered it for context:
[![button test](
https://secure.actblue.com/assets/layout/actblue-511088c1dd12a3bab3ea3a86a243f41939d1ab0bca208367a9635ee494ddd7eb.png)](https://actblue.com)
I've also noticed that when I create a macro to enter markup and then use the macro, it simply puts in the text as is and I have to delete and renter the final ) or ] to make it actually change. Is there a trick here I'm missing?
0
Zsa Trias
Hello Deme,
Have you tried this solution on how you can add linked images into macros: Can I add linked images to tickets using macros?
0
Josh Abreght
Hello Team,
Currently the embedded images isn't working correctly with macros.
If I do the following:
![Test](https://zen-marketing-documentation.s3.amazonaws.com/docs/en/markdown_image.png)
It doesn't work, unless I delete the ending parenthesis and re-add it.
0
Jéssica G. Bigon
Isn't it possible to use this for automation?
0
Ivan Carlos de Almeida
There is any way to enable markdown on knowledge base?
0
Andrew Greenwald
Hello,
I'm having trouble formatting bullet points in Zendesk. When I try to use numbers and letters for bullet points, the formatting gets messed up. For example:
1.
a.
Is there a way to correctly create a multi-step bullet point list in Zendesk?
0