Adding links and formatting to Text
Markdown adds formatting and links to your text through a series of simple tags. Tagging is supported in:
- Notes, including expert commentary (analysis)
- Sharing emails and notifications
- Alert rules
Only the tags detailed below are supported in Metric Insights. Other tags, such as those found here, are not supported.
1. Common Syntax
The following examples show the most commonly used markdown tags that are supported.
1.1. Basic formatting
For the following formatting, surround words with:
- Italics: A single asterisk \* or underscore \_ to *italicize* something.
- Bold: Double asterisk \** or underscore \__ to **bold** something.
- Bold/Italics: Triple asterisk \*** or underscore \___ to ___bold and italicize___ something.
NOTE: Be sure to there are no spaces between the symbols and the text they are highlighting and no carriage returns within the text.
The following markdown code inserted, for example, in a Note, produces the formatted text as shown below:
Use one \* for *italics* and two \** for **bold** and three \*** for ***bold and italics***
1.2. Special Characters
To include special characters, precede them with a backslash "\". Only the special character itself, not the backslash, will show in the text. More than one special character may follow a single backslash.
The following markdown code inserted, for example, in a Note, displays special characters as shown below:
Example\: & ampersand \# pound sign
2. Embedding links with friendly names
Links are made clickable by putting the desired text in brackets [text here] and enclosing the link in parenthesis (link here)
The following markdown code inserted, for example, in a Comment on an Alert, produces the active link as shown below:
For example, here is a friendly looking link to reach the [Metric Insights website](http://www.metricinsights.com)
3. Text Blocks
Both "block quotes" and "code blocks" are supported
3.1. Block Quote
To create a block quote, use a "carrot" on each line within the block. When entering the text, double space between the lines preceded by the ">" to denote the start a new line
The following markdown code inserted, for example, in an Annotation, upon saving, produces the Block Quote shown blow
For a Block Quote >start each line with a " >" [blank space] >that will indent each line like it's quoted [blank space] > be sure there is a blank line between your lines [blank space] > or it will all run together
3.2. Code block
Use three tick marks ``` on a line before and on a line after the text to create a code block that is shaded in red and contains red text
The following markdown code inserted, for example, in a Note produces the Code Block shown blow
``` enter code block text here it will be formatted with red text and a shaded background notice you don't have to skip lines to get a carriage return ```