Documentation
Formatting

Formatting and Markdown

Enhance the readability and visual appeal of your text with Markdown formatting. We offer a variety of Markdown features that allow you to easily style your text without the need for complex coding. Markdown is a lightweight markup language designed for simplicity and ease of use. With it, you can highlight important parts of your text or customize your content to match your desired design effortlessly.

formatting with markdown

Bold text

To bold text, add two asterisks or underscores before and after a word or phrase. To bold the middle of a word for emphasis, add two asterisks without spaces around the letters.

Example: Add feature flag **before** release

bold text formatting

Italic text

To italicize text, add one asterisk or underscore before and after a word or phrase. To italicize the middle of a word for emphasis, add one asterisk without spaces around the letters.

Example: Integrate the system with the *Apollo API* for enhanced performance

italic text formatting

Strikethrough text

To strikethrough words, use two tilde symbols (~~) before and after the words.

Example: We have to use ~~AuthService 1.0~~ which might be deprecated soon 😔

strikethrough text formatting

Code

To denote a word or phrase as code, enclose it in backticks (`).

Example: Refactor all CSS styles which uses `!important`

If the word or phrase you want to denote as code includes one or more backticks, you can escape it by enclosing the word or phrase in double backticks (`).

Example: ``Use `code` in your Markdown file.``

code text formatting

Links

To create a link, enclose the link text in brackets (e.g., [Duck Duck Go]) and then follow it immediately with the URL in parentheses.

Example: Check the [documentation](https://docs.ticktheapp.com/ (opens in a new tab))

To quickly turn a URL or email address into a link, enclose it in angle brackets.

Example: mail us <support@ticktheapp.com>

link text formatting

Date

To add date into text, use two forward slashes (//). Click here to read more about date mention.

date picker open demonstrated

User

To mention user in text, enter an at sign (@) and following text will search user with such a name. Click here to read more about user mention.

user picker open demonstrated

Jira issue

To mention Jira issue in text, enter the issue key in capital letters (for example, KAN-1). Click here to read more about JIRA issue mention.

issue key mention demonstrated issue in progress

Emoji

To add Emoji in text, enter a colon (:) which automatically opens emoji picker to help you choose your desired emoji. Click here to read more about JIRA issue mention.

emoji picker open demonstrated

Video guide