✔️  Available on all subscriptions.

What
Markdown provides a simple way to format text in messages, comments, task descriptions, and notebooks using symbols and characters for basic styling.
Why
  • Make your content look clean and organized without needing to learn complex formatting tools.
  • Add emphasis, lists, and formatted headings when creating messages, comments, tasks, or notebooks.
Who
  • All users 
When
Anytime you want quick styling options for your content.
What
Markdown provides a simple way to format text in messages, comments, task descriptions, and notebooks using symbols and characters for basic styling.
Why
  • Make your content look clean and organized without needing to learn complex formatting tools.
  • Add emphasis, lists, and formatted headings when creating messages, comments, tasks, or notebooks.
Who
  • All users
When
Anytime you want quick styling options for your content.

Enable Markdown

Markdown can be turned on for a Teamwork.com site, giving users access to Markdown functionality across text-based features. When enabled, the default WYSIWYG (what you see is what you get) toolbar is hidden in supported text areas.
 

Site settings

🔑 Site administrators (in the owner company) can access and manage site settings.

  1. Click your profile from the Teamwork.com's main navigation. 
  2. Select Settings.
  3. Select the General tab from the horizontal navigation.
  4. Scroll and search for Use Markdown.
  5. Click the toggle to enable Markdown.
 
Users on your site can use Markdown in text areas (task descriptions, messages, comments, notebooks).


Personal settings

Manage your own personal preferences for Markdown support in messages and comments.

When enabled, the default WYSIWYG (what you see is what you get) editor is hidden. If you edit a message originally created using Markdown, the editor remains in Markdown whether you have it enabled or not.

  1. Click your profile icon in Teamwork.com's main navigation. 
  2. Select Edit my details. 
  3. Switch to the Preferences tab. 
  4. Scroll to the Editing heading.
  5. Toggle on Use 'Markdown' for messages and comments.


Use Markdown

Markdown syntax can be used to format text in comments, messages, task descriptions and notebooks.
💡 Type any of the supported syntax options (outlined below) to manually format text you’re typing in Markdown-supported editors.

Formatting
Syntax
Italic
  • *text between two asterisks*
  • _text between single underscores_
Bold
  • **text between double asterisks**
  • __text between double underscore__
Strikethrough
  • ~~text between double tildes~~
Unordered lists
Use any of the following at the start of each point you want in the list:
  • * (asterisks)
  • + (plus)
  • - (hyphen)
Numbered lists
  • 1. (number followed by a period)
Headings
Apply styled heading sizes:
  • #H1
  • ##H2
  • ###H3
  • ####H4
  • #####H5
  • ######H6
Inline links
  • [visible link text](URL)
Quote text
  • > (quoted text)
  • >> (quoted quote)
Quote list
  • >* 
Horizontal rule
  • ---------- (multiple hyphens)
  • ****** (multiple asterisks) 
  • _______ (multiple underscores)
Code block
  • `code between single backticks`
Inline images
  • ![image alt text](image URL)
Formatting
Syntax
Italic
  • *text between two asterisks*
  • _text between single underscores_
Bold
  • **text between double asterisks**
  • __text between double underscore__
Strikethrough
  • ~~text between double tildes~~
Unordered lists
Use any of the following at the start of each point you want in the list:
  • * (asterisks)
  • + (plus)
  • - (hyphen)
Numbered lists
  • 1. (number followed by a period)
Headings
Apply styled heading sizes:
  • #H1
  • ##H2
  • ###H3
  • ####H4
  • #####H5
  • ######H6
Inline links
  • [visible link text](URL)
Quote text
  • > (quoted text)
  • >> (quoted quote)
Quote list
  • >* 
Horizontal rule
  • ---------- (multiple hyphens)
  • ****** (multiple asterisks) 
  • _______ (multiple underscores)
Code block
  • `code between single backticks`
Inline images
  • ![image alt text](image URL)

Advanced Markdown editor

The advanced Markdown editor allows you to format text across various areas of your site where Markdown is supported. This toolbar gives you quick menu items to insert the relevant Markdown syntax to the editor.

Image Placeholder

Supported options: 
  • Bold, italic, heading size (1-6), strikethrough. 
  • Unordered list and numbered list. 
  • Quote.
  • Link.
  • Inline image.
    • You can paste an image directly to the text area or upload it using the image icon in the toolbar. A link will be created in the text field.
  • Preview: View how your end content will be displayed (Image Placeholder).
  • Hide toolbar: Minimize (or expand) the editor toolbar (Image Placeholder).
 

Create a notebook with Markdown

✔️ Markdown notebooks are available on US-hosted Teamwork.com accounts. The Beta Notebooks editor (available to some Teamwork.com accounts) does not support Markdown. 

  1. Click Jump to in Teamwork.com's main navigation menu. 
  2. Search for and select a project. 
  3. Select Notebooks from the horizontal navigation menu. The Notebooks tab might be hidden under the More... section.
  4. Click the arrow on the Add a Notebook button's right. Reminder: You must have Markdown enabled at site level to create notebooks using Markdown.
    Image Placeholder

  5. Select Use Markdown. 
    6. 📝 The create button's default type (editor or Markdown) is based on the last created notebook's type.
  6. Enter a title and description. 
  7. Enter your notebook content. 
  8. Choose users to be notified. 
  9. Assign a category and/or privacy. 
  10. Click the Notebook contains sensitive content checkbox (if needed). 
  11. Click Create Notebook. 
 
The notebook is created in the project. Notebooks created using Markdown have a blue notebook icon with a Markdown symbol (Image Placeholder).

Best practices

  • Structure: Utilize heading styles (#, ##, ###) to categorize and structure your content. Clear headings help readers quickly navigate through longer content and find information with ease.
  • Preview: Always preview your Markdown-formatted content before sending or publishing to catch any formatting errors or unexpected outcomes.