How to Use Markdown in a Company Policy
Updated At: 2021-11-09
Only Owner can use markdown in a company policy. |
---|
- Markdown is a lightweight markup language that uses plain text to add formatting elements that allows writing contents on the web easy and fast.
- Use markdown to write policy notes in more effective and intuitive ways.
Note
• This article walks through the steps to help you use markdown syntax in a company policy.
• To manage company policy, see Company Settings - General.
You can write a company policy using markdown as below.
Click on Preview button to see how the markdown will appear in a company policy note.
Heading
There are five types of headings in different sizes from h1 to h5.
To create a heading, add hashtags(#) in front of a word or phrase. The number of hashtags correspond to the heading level.
Markdown in Action | Converted into |
---|---|
# h1 ## h2 ### h3 #### h4 ##### h5 |
h1h2h3h4h5 |
You can also use special characters like dashes =, - to format a text.
Markdown in Action | Converted into |
---|---|
h1 == h2 -- |
h1h2 |
Paragraphs
To create paragraphs, use a blank line to separate one or more lines of text.
No matter how many times you change lines, only one line break will be applied.
Markdown in Action | Converted into |
---|---|
First line Second line |
First line Second line |
Font Style
Use special characters like * _ ~ to reflect bold, italic, strike through styles into a font.
Markdown in Action | Converted into |
---|---|
**Bold** __Bold__ *Italic* _Italic_ ~~Strike Through~~ |
Bold Bold Italic Italic |
Numbered List
Use numbers and . to reflect a numbered list.
Markdown in Action | Converted into |
---|---|
1. Numbered List 2. Numbered List 2-1. Numbered List 2-2. Numbered List 3. Numbered List 3-1. Numbered List |
1. Numbered List 2. Numbered List 2-1. Numbered List 2-2. Numbered List 3. Numbered List 3-1. Numbered List |
URL Link
Markdown supports two style of links: inline and reference.
Markdown in Action | Converted into |
---|---|
Inline Link [Shiftee](https://shiftee.io/en) Reference Link < https://shiftee.io/en > |
Shiftee support@shiftee.io |