Markdown is a simple markup language you can use to easily add formatting, links, and images to plain text. You can use it in the following places:
- Goal Comments
- Diary Notes
- Establishment Description
- Diary Note Descriptions and Follow Ups
- PIP (Performance Improvement) Descriptions, Actions to be Taken, and Follow Ups
- Goal Descriptions and Measurement Names
- Note Descriptions
- Skill Descriptions
- Goal Comments
- Qualification Comments
- Onboarding Form Templates
Markdown commands are automatically supported. You can enter Markdown comments to format your content. See Table 1 below for supported Markdown commands
Topics covered in this article:
- Adding Markdown to text
- Bold
- Italics
- Bulleted lists
- Numbered lists
- Nested lists
- Headings
- Block quotes
- Code blocks
- Images
- Links
- Images that are also links
- Horizontal line rule
- Line break
_________________________________________________________________
Using Markdown
You can use Markdown commands in Goal Comments section at the bottom of the Goals page and in Diary Notes under the Manager's Log in the Description section at the bottom of the page.
Adding Markdown to Text
The following table shows examples of how you can use Markdown to add common formatting. You don't need to preview your formatting. Your content is formatted automatically as you enter Markdown commands.
Formatting | Entered text | Published text | Comments |
---|---|---|---|
Bold |
This is how you **bold** text. | This is how you bold text. | Supported |
Italics |
This is how you *italicize* text. | This is how you italicize text. | Supported |
Bulleted lists |
* Bullet one (don't forget a space after the asterisk)
* Bullet two Note: You must type a line break before and after the list.
|
|
Supported. You can also start with a hyphen (-) followed by a space to create a bulleted list. |
Numbered lists |
1. Step one
2. Step two Note: Do not use a hashtag (#) when creating numbered lists in Markdown, as the symbol is used for other formatting.
Note: You must type a line break before and after the list.
|
|
Supported |
Nested lists |
* This is the first level of this list.
* To make a second level, add two spaces before the asterisk or number. Note: You can add things like images, quote blocks, or links to a nested list in addition to just text.
Note: You must type a line break before and after the list.
|
|
Supported everywhere except Onboarding Form Templates. For the second level of indent, press Tab after the bulleted list or numbered list. |
Headings |
# Heading level one (with a space after the #)
## Heading level two ### Heading level three You can add up to six heading levels. Note: You can add a row of equal signs (=) under a line of text to create Heading level one, or a row of dashes (-) under a line of text to create a Heading level two.
|
Heading level oneHeading level twoHeading Level three |
Supported everywhere except Onboarding Form Templates. Up to four heading levels. |
Block quotes |
> Block quotes have to start and end with a blank line > And each line of the quote starts with a right angle bracket and a space
|
Supported everywhere except Onboarding Form Templates. | |
Code blocks |
```
This is a code block. ``` Note: Creating a blank line and then indenting the next line or lines with four spaces creates a code block too.
Note: You must type a line break before and after the code block.
|
Supported everywhere except Onboarding Form Templates. To exit a code block placed at the end of a comment, press the Return key three times in a row. |
|
Images |
![Optional alternative text if image doesn't load](http://www.sampleurl.com/logo.png) |
Supported everywhere except Onboarding Form Templates. Adding an image URL automatically turns it into an image link. |
|
Links |
[Link display text](http://www.sampleurl.com) | Link display text | Supported in Onboarding Form Templates only. |
Images that are also links |
[![alt text](imageurl)](linkurl) | Not supported | |
Horizontal rule line |
--- Note: You must type a line break before and after the hyphens.
|
|
Supported everywhere except Onboarding Form Templates. |
Line break |
Line 1
Line 2
Note: You must type two line breaks before each .
|
Line 1
Line 2
|
Supported everywhere except Onboarding Form Templates. |
Comments
1 comment
Using Markdown in a contract of over 35 pages is not efficient or helpful when you need to send it to lawyers in a .docx format.
Please sign in to leave a comment.