Markdown Guide

StatusDashboard currently supports markdown formatting on many entry text fields and their corresponding display on status dashboards and notification channels. Any text entry field that supports markdown formatting will have an accompanying toggle button that a markdown editor to be loaded to make editing markdown easier. Customers who wish to have the markdown editor enabled by default when creating or updating events may enable this option for their user account by navigating to User Profile > Options > Markdown in the StatusDashboard administration portal.

When using markdown, customers are also encouraged to test markdown using our markdown testing tool located in the StatusDashboard administration portal at Miscellaneous > Markdown Test to confirm how markdown will actually be rendered on status dashboards. 

Current Markdown Support

Not all notification methods have the same level of support for markdown. If using multiple notification methods, you should only use the lowest common markdown attributes that are supported by all of them.

Note: Certain notification methods (e.g. email) require two spaces at the end of a line to signify a line break in the resultant email. When authoring content where you specifically want new lines to be rendered, ensure that you place two spaces at end end of each line. The StatusDashboard markdown editor has a visual aid to assist you in ensuring you have new lines present (the glasses toggle button in the editor toolbar).

Notification Method	Supported Markdown
Email	Bold text Italic text Hyperlinks Numbered list Bullet list
Google Chat	Bold text Italic text Hyperlinks Strikethrough text
Microsoft Teams	Bold text Italic text Hyperlinks Numbered list Bullet list
Slack	Bold text Italic text Hyperlinks Numbered lists Bullet lists Strikethrough text Block quotes Inline code