Markdown is a lightweight and easy-to-use syntax for styling text descriptions and comments in Targetprocess entities.

What is Markdown?

Markdown is a way to style text on the web. Formatting words as bold or italic, adding images, and creating lists are just a few of the things users can do with Markdown quite easily. Mostly, Markdown is just regular plain text with a few non-alphabetic characters thrown in, like # or *.

Examples

Text	It's very easy to make some words **bold** (or __bold__) and other words *italic* (or _italic_) with Markdown. You can even [link to Google!](http://google.com)	It's very easy to make some words bold (or bold) and other words italic (or italic) with Markdown. You can even link to Google!
Lists	Sometimes you want numbered lists: 1. One 2. Two 3. Three Sometimes you want bullet points: * Start a line with a star * Profit!	Sometimes you want numbered lists: One Two Three Sometimes you want bullet points: Start a line with a star Profit!
Images	If you want to embed images, this is how you do it: 	If you want to embed images, this is how you do it:
Headers	# Structured documents Sometimes it's useful to have different levels of headings to structure your documents. Start lines with a `#` to create headings. Multiple `##` in a row denote smaller heading sizes. ## This is a heading H2 ### This is a heading H3	Structured documents Sometimes it’s useful to have different levels of headings to structure your documents. Start lines with a # to create headings. Multiple ## in a row denote smaller heading sizes. This is a heading H2 This is a heading H3

How to enable Markdown mode?

Starting from version 3.13.9 Markdown is available as a user specific setting and can be enabled separately for every user in the Account settings tab.

In the earlier versions starting from version 3.7.0 formatting mode for text editors in entity descriptions and comments was a common setting for the whole account. The switch can be done by Administrators  and affects all the processes and users. Once switch to Markdown format is done, it is applied to a newly created entities. Items created prior to the switch still use WYSIWYG formatting and embedded CK Editor. Selection can be reverted back safely without any data loss.

Administrators select the default editor from the Settings → General Settings → Text editor type.

Syntax guide

Here is an overview of Markdown syntax that you can use in Targetprocess a description and comments.

Headers

# This is an <h1> tag
## This is an <h2> tag
###### This is an <h6> tag

Emphasis

*This text will be italic*
_This will also be italic_
**This text will be bold**
__This will also be bold__
*You **can** combine them*

Strikethrough

Any word wrapped with two tildes (like ~~this~~) will appear crossed out.

Lists

Unordered:

* Item 1
* Item 2
  * Item 2a
  * Item 2b

Ordered:

1. Item 1
2. Item 2
3. Item 3
  * Item 3a
  * Item 3b

Images

![Targetprocess Logo](/images/logo.png)

Format:

![Alt Text](url)

Links

Any URL (like https://targetprocess.com/) will be automatically converted into a clickable link.

You can also create a link to another Targetprocess entity using ID:12345 syntax.

Formatted links

Custom caption:

[Targetprocess](https://targetprocess.com/)

Bold link:

[**Targetprocess**](https://targetprocess.com/)

Strikethrough link:

[~~Targetprocess~~](https://targetprocess.com/)

Blockquotes

If you'd like to quote someone, use the > character before the line:

> Coffee. The finest organic suspension ever devised... I beat the Borg with it.
> - Captain Janeway

Coffee. The finest organic suspension ever devised… I beat the Borg with it.
- Captain Janeway

Inline code

There are many different ways to style code with Targetprocess markdown.

If you have inline code blocks, wrap them in backticks `...`.

I think you should use an `<addr>` element here instead.

Here is what you'll get:

I think you should use an <addr> element here instead.

If you’ve got a longer block of code, you can indent with four spaces:

    if (isAwesome) {
      return true
    }

Targetprocess also supports something called code fencing, which allows for multiple lines without indentation:

```
if (isAwesome) {
  return true
}
```

And if you’d like to use syntax highlighting, include the language:

```javascript
    function fancyAlert(arg) {
      if(arg) {
        $.facebox({div:'#foo'})
      }
    }
```

Tables

You can create tables by assembling a list of words and dividing them with hyphens - (for the first row), and then separating each column with a pipe |. For example:

You can create tables by assembling a list of words and dividing them with hyphens `-` (for the first row).
Then separate each column with a pipe `|`:

First Header | Second Header
------------ | -------------
Content from cell 1 | Content from cell 2
Content in the first column | Content in the second column

Would become:

@mentions in comments

Typing a @ symbol, followed by a user name or a team name, will notify that person/team to come and view the comment.

Hey @admin — love your sweater!

Hey admin — love your sweater!

More on this feature: Mention people and teams in comments.

Emoji

Targetprocess supports emoji!

:sparkles: :camel: :boom:

To see a list of available images, check out the Emoji Cheat Sheet.