Back to Mavenlink.com Blog Tour Status

Formatting Markdown

Overview

Markdown is a lightweight, human-readable markup language used for formatting text. It’s a simple way to add things like bold, italics, lists, links, lines, and—if you want to be really expressive—emoji to the text you post in your Activity feeds or task descriptions

post-formatting-3.pngMarkdown is available in the following areas:

  • When creating or editing new posts in a project's Activity Feed.
  • When creating or editing new posts in the Activity section of the Task Details side panel.
  • When adding or editing a task description in the Details section of the Task Details side panel.
  • When you respond to posts in the Dashboard's Activity Feed.
  • When adding a description to a task from Project Templates.
  • When adding a description to a new task in the Task Tracker.

Markdown formatting is preserved and appears correctly in your daily activity digest emails (i.e. the emails sent out with your Activity Feed posts).

However, keep in mind that, although the markup syntax will be preserved, the formatting will not be displayed for task descriptions in Insights, the global Tasks list (if the Description column is configured), or when you export a task list from the Task Tracker or the global Tasks list.

Adding Markdown

The following table demonstrates how markdown can be used to add common formatting to descriptions and posts. There are multiple ways to achieve the same formatting. 

Formatting Entered text Published text
Bold This is how you **bold** text.
This is also how you __bold__ text.
post-formatting-bold.png
Italics This is how you _italicize_ text.
This is also how you *italicize* text.
post-formatting-italicize.png
Underline This is how you ==underline== text. post-formatting-underline.png
Bulleted lists * Bullet type 1
- Bullet type 2
+ Bullet type 3

Don't forget a space after the asterisk, hyphen, or plus symbol.
post-formatting-bullet-list.png
Numbered lists 1. Step one
2) Step two

Don't forget a space after the period.
post-formatting-numbered-list.png
Links http://www.sampleurl.com post-formatting-url.png
Horizontal line Use three hyphens ---.
You can also use three *** or ___.

Don't forget a line break before and after your horizontal line.
post-formatting-hoizontal-line.png
Emoji :smile: smile.png

You can also use the toolbar below the activity post field or task description field to add bold, italics, underline, bullet lists, numbered lists, and emoji.post-formatting-toolbar.png

Previewing Markdown

When using markdown in Activity Feed posts or task descriptions, you can Preview your formatting before saving or submitting the post. First, create or edit your post using markdown formatting.

post-formatting.png

Next, click Preview to see how your text will look.

post-formatting-2.png

Emoji Markdown

Sometimes words aren't enough and only an 🙄 emoji can adequately express how you feel. Thankfully, you can add emoji using simple markdown syntax; just wrap the name of an emoji in colons, such as :unicorn: and Mavenlink will render a beautiful 🦄.

The names of emoji will autocomplete for you. So, if you start typing :uni, a list of matching emoji will appear; press <enter> or <tab> to add them to your post.

Feel free to use the following Emoji Cheat Sheet as reference.

 

Created on

Can't find what you're looking for?

Live Chat Submit a Ticket