Markdown Support

[ 1 What is Markdown? ] [ 2 Headings ] [ 3 Links ] [ 4 Emphasis ] [ 5 Line Separators ] [ 6 Lists ] [ 7 Blockquotes ] [ 8 Code ] [ 9 Code Blocks ] [ 10 Images ] [ 11 Custom Examples ] [ 12 HTML Table ]

What is Markdown?

Markdown is a markup language used to add formatting elements to plaintext text documents. It is written as a regular text along with a few non-alphabetic characters such as a number sign or an asterisk # or *.

Markdown support in Case Management

Case Management supports some of the basic Markdown and HTML syntax that you can use in the Summary and Comments section or in your own text files. The syntaxes are described below with examples and output that is rendered.

Headings

To create a heading, add a number sign (#) in front of a word or phrase. The number of number signs you use should correspond to the heading level. For example:

To create a Markdown heading level three, use three number signs ### Heading 3.
To create an HTML heading level three, use heading tag <h3>Heading 3</h3>

# Heading level 1
## Heading level 2
### Heading level 3
#### Heading level 4
##### Heading level 5
###### Heading level 6

&lt;h1&gt;Heading level 1&lt;/h1&gt;
&lt;h2&gt;Heading level 2&lt;/h2&gt;    
&lt;h3&gt;Heading level 3&lt;/h3&gt;
&lt;h4&gt;Heading level 4&lt;/h4&gt;
&lt;h5&gt;Heading level 5&lt;/h5&gt;
&lt;h6&gt;Heading level 6&lt;/h6&gt;

Alternative Markdown Syntax

Alternatively, on the line below the text, add any number of == characters for heading level 1 or -- characters for heading level 2.

Heading level 1
===============

Heading level 2
---------------

Links

To create a link, enclose the text in brackets (example, [Google Search Engine]) and then follow it immediately with the URL in parentheses (example, (https://www.google.com/)).

[Google Search Engine](https://www.google.com/) is the best search engine in the world.

Links: Reference-style

Reference-style links are a special kind of link that makes URLs easier to display and read in Markdown. These links are constructed in two parts:

The part you keep in line with your text.
The part you store somewhere else in the file to keep the text easy to read.

The first part of a reference-style link is formatted with two sets of brackets.

The first set of brackets surrounds the text that should appear linked.
The second set of brackets displays a label used to point to the link you’re storing elsewhere in your document.

Special considerations

Although not required, you can include a space between the first and second set of brackets. The label in the second set of brackets is not case sensitive and can include letters, numbers, spaces, or punctuation.

[Google] [1]
[Wikipedia] [2]

[1]: https://www.google.com/
[2]: https://www.wikipedia.org/

Emphasis

You can add emphasis using * or _ wrapped words and phrases as bold and italic emphasis. Refer to the examples below.

Bold

To bold text, add two asterisks or underscores before and after a word or phrase.

Bold in mid-word

To bold the middle of a word for emphasis, add two asterisks without spaces around the letters.

I love to use **Case Management**.
I love to use __Case Management__.
I love to use**Case Management**in.

I love to use &lt;strong&gt;Case Management&lt;/strong&gt.
I love to use &lt;strong&gt;Case Management&lt;/strong&gt.
I love to use&lt;strong&gt;Case Management&lt;/strong&gt.

Italics

To italicize text, add one asterisk or underscore before and after a word or phrase.

Automate your tasks using *Playbooks* 
Automate your tasks using _Playbooks_
Automate your tasks using*Playbooks*

Automate your tasks using &lt;em&gt;Playbooks&lt;/em&gt; 
Automate your tasks using &lt;em&gt;Playbooks&lt;/em&gt;
Automate your tasks using&lt;em&gt;Playbooks&lt;/em&gt;

Bold and Italic

To emphasize text with bold and italics at the same time, add three asterisks or underscores before and after a word or phrase.

provides ***100s of integrations*** out of the box
provides ___100s of integrations___ out of the box
provides __*100s of integrations*__ out of the box
provides **_100s of integrations_** out of the box
provides***100s of integrations***out of the box

provides &lt;strong&gt;&lt;em&gt;100s of integrations&lt;/em&gt;&lt;/strong&gt; out of the box
provides &lt;strong&gt;&lt;em&gt;100s of integrations&lt;/em&gt;&lt;/strong&gt; out of the box
provides &lt;strong&gt;&lt;em&gt;100s of integrations&lt;/em&gt;&lt;/strong&gt; out of the box
provides &lt;strong&gt;&lt;em&gt;100s of integrations&lt;/em&gt;&lt;/strong&gt; out of the box
provides&lt;strong&gt;&lt;em&gt;100s of integrations&lt;/em&gt;&lt;/strong&gt;out of the box

Strikethrough

To strikethrough text, add two tildes (~) before and after a word or phrase.

~~I didn't mean to write this~~

Line Separators

To add a line separator, you can use a line with three or more dashes with an extra blank line before and after or three or more * characters.

___ 

__________

**********

Lists

You can organize items into ordered and unordered lists.

Ordered Lists

To create an ordered list, add line items with numbers followed by periods. The numbers don’t have to be in numerical order, but the list should start with the number one.

1. First item
2. Second item
3. Third item
4. Fourth item

&lt;ol&gt;
&lt;li&gt;First item&lt;/li&gt;
&lt;li&gt;Second item&lt;/li&gt;
&lt;li&gt;Third item&lt;/li&gt;
&lt;li&gt;Fourth item&lt;/li&gt;
&lt;/ol&gt;

Ordered Lists: Indentation

To indent the sub-items in an ordered list, use at least two or four spaces and add the sub-item numbering such as a, i, or the number itself.

1. First item
2. Second item
3. Third item
    1. Indented item
    2. Indented item
4. Fourth item

&lt;ol&gt;
&lt;li&gt;First item&lt;/li&gt;
&lt;li&gt;Second item&lt;/li&gt;
&lt;li&gt;Third item
&lt;ol&gt;
&lt;li&gt;Indented item&lt;/li&gt;
&lt;li&gt;Indented item&lt;/li&gt;
&lt;/ol&gt;
&lt;/li&gt;
&lt;li&gt;Fourth item&lt;/li&gt;
&lt;/ol&gt;

Unordered Lists

To create an unordered list, add dashes (-), asterisks (*), or plus signs (+) in front of line items. Indent one or more items to create a nested list.

- First item
- Second item
- Third item
- Fourth item

* First item
* Second item
* Third item
* Fourth item

+ First item
+ Second item
+ Third item
+ Fourth item

&lt;ul&gt;
&lt;li&gt;First item&lt;/li&gt;
&lt;li&gt;Second item&lt;/li&gt;
&lt;li&gt;Third item&lt;/li&gt;
&lt;li&gt;Fourth item&lt;/li&gt;
&lt;/ul&gt;

Unordered Lists: Indentation

- First item
- Second item
- Third item
    - Indented item
    - Indented item
- Fourth item

&lt;ul&gt;
&lt;li&gt;First item&lt;/li&gt;
&lt;li&gt;Second item&lt;/li&gt;
&lt;li&gt;Third item
&lt;ul&gt;
&lt;li&gt;Indented item&lt;/li&gt;
&lt;li&gt;Indented item&lt;/li&gt;
&lt;/ul&gt;
&lt;/li&gt;
&lt;li&gt;Fourth item&lt;/li&gt;
&lt;/ul&gt;

Blockquotes

To create a blockquote, add a greater-than angle bracket >.

> This is a blockquote text.

Blockquotes: Nested

To create a nested blockquote, use two greater-than angle bracket >

&gt; This is a blockquote.

&gt;&gt; A blockquote would look great indented.

Blockquotes with Other Elements

You can include other elements within a blockquote.

&gt; Quoted text

&gt; ### With a Heading

&gt; And other elements, such as:

&gt; - Bullets

&gt; - **Bold text**

&gt; - *italics!*

Code

To create a code format text such as a command or a code snippet, wrap the text with backticks ()`.

At the command prompt, type `cmd`.

At the command prompt, type <code>cmd</code>.

Code: Disable Automatic URL Linking

You can use code definition to prevent URLs from being turned into links automatically.

`https://www.google.com/`

Code Blocks

To create code blocks, indent every line by at least four spaces or a tab.

{
    "firstName": "John",
    "lastName": "Smith",
    "age": 25
}

Code Blocks: Fenced Code Blocks

To create fenced code blocks, use three backticks (```) on the lines before and after the code block.

```
{
"firstName": "John",
"lastName": "Smith",
"age": 25
}
```

Images

To add an image, add an exclamation mark (!), followed by alt text in brackets, and the path or URL to the image asset in parentheses.

The title appears when you mouseover on the image. The alt text shows when the image fails to load. In the example below, the alt text/title text is "Devo".

![Devo](/images/logos/logo.svg "Devo")

Custom Examples

The following are some custom HTML examples that may be useful in more advanced cases.

Definition Lists via HTML

A definition list is a list of terms and corresponding definitions.

Extended markdown not supported

Devo SOAR does not support the extended markdown version of the definition lists, but it can be done via HTML.

&lt;dl&gt;
    &lt;dt&gt;First Term&lt;/dt&gt;
    &lt;dd&gt;This is the definition of the first term.&lt;/dd&gt;
    &lt;dt&gt;Second Term&lt;/dt&gt;
    &lt;dd&gt;This is one definition of the second term.&lt;/dd&gt;
    &lt;dd&gt;This is another definition of the second term.&lt;/dd&gt;
&lt;/dl&gt;

Text Color

You can define colored text using HTML.

<font color=green>colored text.</font>

HTML Table

HTML Table: Basic Formatting

You can format a simple HTML table.

&lt;table&gt;

&lt;tr&gt;&lt;td&gt;Server&lt;/td&gt;&lt;td&gt;Disk Usage&lt;/td&gt;&lt;/tr&gt;

&lt;tr&gt;&lt;td&gt;Server 1&lt;/td&gt;&lt;td&gt;93% (426 GB)&lt;/td&gt;&lt;/tr&gt;

&lt;tr&gt;&lt;td&gt;Server 2&lt;/td&gt;&lt;td&gt;75% (344 GB)&lt;/td&gt;&lt;/tr&gt;

&lt;tr&gt;&lt;td&gt;Server 3&lt;/td&gt;&lt;td&gt;43% (197 GB)&lt;/td&gt;&lt;/tr&gt;

&lt;tr&gt;&lt;td&gt;Server 4&lt;/td&gt;&lt;td&gt;24% (110 GB)&lt;/td&gt;&lt;/tr&gt;

&lt;/table&gt;

HTML Table: Advanced Formatting

You can format a robust version of the table with some of the enhancements, such as:

Specific widths for each column and for the table as a whole
Set the first row as the header row
Alternating background color for standard text
Customized background color by severity
Specific cell padding and margin

&lt;head&gt;

&lt;style&gt;

.test_table {

    width:323px;

    border: 2px solid black;

}

.test_table table, th, tr, td {

    margin:0;

    padding:4px;

}

.test_table th {

    background-color: #f0f1f2;

    border: 2px solid black;

}

.test_table td {border: 2px solid black; }

.test_table r:nth-child(even) { background-color: #f0f1f2; }

.sev1 { background-color: #ff8080; }

.sev2 { background-color: #ffe0b3; }

.sev3 { background-color: #ffff99; }

.sev4 { background-color: #b1ff99; }

&lt;/style&gt;

&lt;/head&gt;

&lt;table class="test_table"&gt;

&lt;colgroup&gt;

&lt;col span="1" style=:"width: 200px;"&gt;

&lt;col span="1" style="width: 120px;"&gt;

&lt;/colgroup&gt;

&lt;thead&gt;

&lt;tr&gt;&lt;th&gt;Server&lt;/th&gt;&lt;th&gt;Disk Usage&lt;/th&gt;&lt;/tr&gt;

&lt;/thead&gt;

&lt;tbody&gt;

&lt;tr&gt;&lt;td&gt;Server 1&lt;/td&gt;&lt;td class="sev1"&gt;93% (426 GB)&lt;/td&gt;&lt;/tr&gt;

&lt;tr&gt;&lt;td&gt;Server 2&lt;/td&gt;&lt;td class="sev2"&gt;75% (344 GB)&lt;/td&gt;&lt;/tr&gt;

&lt;tr&gt;&lt;td&gt;Server 3&lt;/td&gt;&lt;td class="sev3"&gt;43% (197 GB)&lt;/td&gt;&lt;/tr&gt;

&lt;tr&gt;&lt;td&gt;Server 4&lt;/td&gt;&lt;td class="sev4"&gt;24% (110 GB)&lt;/td&gt;&lt;/tr&gt;

&lt;/tbody&gt;

&lt;/table&gt;