Within Teamwork, you can enable markdown for your site so that text in notebooks, comments, messages etc. can be formatted using markdown code.
Markdown is a type of code that allows you to format text using characters directly within the text. For example, an asterisk either side of a word or phrase *like this* will be interpreted in markdown as italic text like this.
To enable markdown, click your profile icon in the bottom left of your site and select Settings from the pop-out menu.
Within the Settings area, go to the General tab where you will find an option to enable markdown.
Once markdown is enabled, users on your site will be able to use markdown in text areas such as task descriptions, messages, and comments, as well as create notebooks using markdown.
Individual users can enable or disable markdown for messages/comments in their profile preferences. When enabled, the default HTML WYSIWYG (what you see is what you get) editor won't be visible.
You can create emphasis on plain text such as bold, italics, or strikethrough.
Emphasis/italics syntax:
- *asterisk*
- _underscore_
- Example: *I have emphasis* = I have emphasis
Strong emphasis/bold syntax:
- **double asterisks**
- __double underscore__
- Example: __I have strong emphasis__ = I have strong emphasis
Strikethrough syntax:
- ~~double tildes~~
- Example: ~~Scratch this~~ =
Scratch this
Markdown supports ordered (numbered) and unordered (bulleted) lists.
For unordered lists, you can use asterisks, pluses, and hyphens:
- Item 1
- Item 2
* Item 3
+ Item 4
Displays as:
- Item 1
- Item 2
- Item 3
- Item 4
Ordered lists use numbers followed by periods:
1. Apples
2. Oranges
3. Pears
Displays as:
- Apples
- Oranges
- Pears
You can use hashtags to format text to heading styles:
# H1
## H2
### H3
#### H4
##### H5
###### H6
Displays as:
Heading 1
Heading 2
Heading 3
Heading 4
Heading 5
Heading 6
Using markdown, you add inline and reference links to your content.
Inline
You can create inline links by adding link text between square brackets [ ], directly followed by the URL in parentheses( ).
Syntax: Take a look at [our homepage]( https://www.teamwork.com) for more information.
Displays as: Take a look at our homepage for more information.
Title text can also be specified, and will display when someone hovers over the link:
Syntax: [link text](URL "title text)
Example: [Teamwork]( https://www.teamwork.com "Teamwork")
Referenced
You can also use referenced-style links to create a document source, making your content more readable.
Example:
Visit our [homepage][1] and [help docs][2] for more information.
[1]: https://teamwork.com "homepage"
[2]: https://www.teamwork.com/support "support"
Displays as:
Using block quotes, you can highlight certain areas of content:
> Quoted text.
> > Quoted quote.
> * Quoted
> * List
You can create horizontal rules in your content using three or more hyphens, asterisks, or underscores.
Example:
This one uses hyphens.
---
This one uses asterisks.
***
This one uses underscores.
___
Displays as:
To format text to code style, place the text between two single grave accents (back ticks).
Example:
`This is a piece of code`
Displays as:
You can also add multi-line blocks of code:
~~~~
This is a
piece of code
in a block.
~~~~
```css
#memo {
border: none;
font-color: blue;
}
```
Display as:
You can add images in either inline or reference style.
Inline-style
Displays as:
Reference-style
Second Chart: ![Chart 2][chart]
[chart]: https://tw-desk-files.teamwork.com/i/1/attachment-inline/197378.20190118104115820.197378.201901181041158203qtW7.png "Chart 2"
Displays as:
For more information, see: Creating a Notebook with Markdown