Markdown
Design / Markdown

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 event emails.  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 console.

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 console at Miscellaneous > Markdown Test to confirm how markdown will actually be rendered on the dashboard. 

Basic 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:

This is an [example link](http://example.com/).

Which produces the following in the resultant dashboard or email display:

  
<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:

Some of these words *are emphasized*.
Some of these words _are emphasized also_.

Use two asterisks for **strong emphasis**.
Or, if you prefer, __use two underscores instead__.

Which produces the following in the resultant dashboard or email display:

  
<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:

* one
* two
* three

+ one
+ two
+ three

- one
- two
- three

Which produces the following in the resultant dashboard or email display:

  
<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:

1. one
2. two
3. three

Which produces the following in the resultant dashboard or email display:

  
<ol>
  <li>one</li>
  <li>two</li>
  <li>three</li>
</ol>
  

Still have questions?  Contact our support team.  We're always happy to help with any questions you might have.