StatusDashboard currently supports markdown formatting on many of our text entry fields. Any text entry fields that support markdown formatting will have an accompanying toggle button that allows markdown to be enabled, or they will have a markdown option in the relevant API call. Additionally, markdown formatting will be used (if selected) in the formatting of text in relevant notification channels. Customers who wish to have markdown 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.
Caution should be used when enabling markdown as the resultant HTML could have unintended consequences in terms of distorting the dashboard or HTML formatted event emails. Although we do provide a markdown editor that has native previewing functionality, 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 the dashboard.
Markdown Formatting Guide
Links |
Use square brackets to delimit the text you want to turn into a link, followed by parentheses around the target link, like this: <p>This is an <a href="http://example.com/">example link</a>.</p> |
Emphasis |
Emphasis is created using asterisks and underscores to indicate spans of emphasis, like this: <p>Some of these words <em>are emphasized</em>. Some of these words <em>are emphasized also</em>.</p> <p>Use two asterisks for <strong>strong emphasis</strong>. Or, if you prefer, <strong>use two underscores instead</strong>.</p> |
Unordered Lists |
Unordered (bulleted) lists use asterisks, pluses, and hyphens (*, +, and -) as list markers. These three markers are interchangable, like this: note: to provide separation between the end of the ordered list and a new line of text, include a blank line with two spaces and a carriage return after the list. <ul> <li>one</li> <li>two</li> <li>three</li> </ul> |
Ordered Lists |
Ordered (numbered) lists use regular numbers, followed by periods, as list markers: note: to provide separation between the end of the ordered list and a new line of text, include a blank line with two spaces and a carriage return after the list. <ol> <li>one</li> <li>two</li> <li>three</li> </ol> |
Multi-Line Text (with carriage returns) | When creating multi-line text with carriage returns (not lists), you must enter two blank spaces and then the carriage return on each line in order for the text to be properly rendered on multiple lines. If you do not include two blank spaces before the carriage return, then the text will be rendered on a single line, regardless of carriage returns. |