Formatting Guide & Markdown

Formatting Guide & Markdown

Learn how to format your checklist effectively – add due dates, mention users, structure content, and enhance readability!

Β 

Text Formatting

Checklist UI

Markdown

Checklist UI

Markdown

**bold text** _italic text_ `emphasize`

Β 

Β 

Headers

Checklist UI

Markdown

Checklist UI

Markdown

image-20260612-155713.png
# Biggest heading ## Big heading ### Heading #### Small heading ##### Smaller heading ###### Smallest headi

πŸ’‘HINT: Learn more about working with Headers from -> Checklist Headers

Β 

Checklist Tabs

Both H1 headers (headers starting with # ) and checklist tabs use the same markdown syntax: # Header name / Tab name

Checklist UI

Markdown

Checklist UI

Markdown

image-20260119-125458.png
# Code Quality - Code is written and merged - No critical bugs remain - Unit tests are written and passing # Testing - Feature is covered by automated tests - Integration tests are passed - Acceptance criteria are validated # Documentation - User documentation is updated. - Technical documentation is updated

πŸ’‘ HINT: If user works with checklist in Tab view, H1 headers (starting with #) are displayed as tabs, List view – all tabs appear as H1 headers in the checklist.

πŸ“– Learn more about working with Checklist Tabs from -> Checklist Tabs

Β 

Statuses

Checklist UI

Markdown

Checklist UI

Markdown

image-20260612-160235.png
- item todo + item done ~ item in progress x item skipped - [Failed] item in custom status

Read more how to work statuses here β†’ Checklist Statuses

Β 

Priority

Checklist UI

Markdown

Checklist UI

Markdown

image-20260612-160038.png
- [priority="High"] checklist item with High priority - [priority="Medium"] checklist item with Medium priority - [priority="Low"] checklist item with Low priority

Read more how to work with Checklist Priority, Assignee and Due Date here β†’ Checklist Priority, Assignee, Due Date

Β 

Assignee

Checklist UI

Markdown

Checklist UI

Markdown

image-20260612-154851.png
- [assignee="<userId>"] item with assigned user - [assignee="<userId>"] item with assigned user - [assignee="<userId>"] item with assigned user

πŸ’‘HINT: Read more how to work with Checklist Priority, Assignee and Due Date here β†’ Checklist Priority, Assignee, Due Date

Β 

Due Date

Checklist UI

Markdown

Checklist UI

Markdown

image-20260612-154504.png
- [dueDate="2026-06-07"] date in past - [dueDate="2026-07-04"] date in the future - [dueDate="2026-06-12"] today

πŸ’‘HINT: Read more how to work with Checklist Priority, Assignee and Due Date here β†’ Checklist Priority, Assignee, Due Date

User Mentions

To add user mention just start typing @ and user name. You can mention multiple users.

Checklist UI

Markdown

Checklist UI

Markdown

image-20260612-160903.png

Β 

- current user @<userID> - another Jira user @<userID> - custom user mention @DevTeam

πŸ’‘HINT: You can also Notify Checklist Assignees by Email or JQL Search πŸš€

Β 

Β 

Date Mentions

Smart Checklist supports the following date formats: DD-MM-YYYY, DD/MM/YYYY, YYYY/MM/DD, YYYY-DD-MM

You can also easily access a calendar by typing //:

Checklist UI

Markdown

Checklist UI

Markdown

image-20260612-154656.png
- date in past 2026-06-07 - date in the future 2026-07-10 - today 2026-06-12

Β 

Mandatory items

Checklist UI

Markdown

Checklist UI

Markdown

image-20260612-155518.png

Β 

-! Mandatory Item ToDo ~! Mandatory Item In Progress x! Mandatory Item Skipped +! Mandatory Item Done -! [PASSED] Mandatory Item Custom Status

πŸ’‘HINT: Read more about Mandatory Items here β†’ Mandatory Items

Β 

Β 

Item Details

Checklist UI

Markdown

Checklist UI

Markdown

- item todo > piece of information > that is useful for new ppl > on how to complete an item > even `with` **markdown** *support*

Add details

add details by hovering the checklist item
add details via 3-dots menu

Edit details

edit details by clicking on the pencil icon
edit details by clicking on them

Β 

Delete details

delete details by hovering the checklist item
delete details via 3-dots menu

Bullet points and Lists

You can make your checklist item details as a list or add bullet points:

Checklist UI

Markdown

Checklist UI

Markdown

- item todo > * bullet point one > * bullet point two > > * bullet point nested > 1. list item one > 2. list item two

External links

Checklist UI

Markdown

Checklist UI

Markdown

image-20260612-161515.png

Β 

- http://google.com - [link to google](http://google.com

Β 

Jira Issues Links

Checklist UI

Markdown

Checklist UI

Markdown

image-20260612-161641.png

Β 

- https://jira.atlassian.net/browse/RVCH-32

Β 

Emojis 😎

Start typing : to access emojis:

image-20260612-161938.png

Checklist UI

Markdown

Checklist UI

Markdown

image-20260612-161907.png

Β 

- Emoji :heart: - Emoji :grinning: - Emoji :white_check_mark:

Β 

Images

Checklist UI

Markdown

Checklist UI

Markdown

- ![alt text](https://secure.gravatar.com/avatar/298d18e3a60322f41bccfe9574eca2b7?s=160&d=identicon&r=g)

Β 

Β 

Display text in [ ]

Markdown

Checklist UI

Markdown

Checklist UI

~ \[Text in brackets\]

Β