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 |
|---|---|
**bold text**
_italic text_
`emphasize`Β |
Β
Headers
Checklist UI | Markdown |
|---|---|
# 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 |
|---|---|
# 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 |
|---|---|
- 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 |
|---|---|
- [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 |
|---|---|
- [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 |
|---|---|
- [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 |
|---|---|
Β | - 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 |
|---|---|
- date in past 2026-06-07
- date in the future 2026-07-10
- today 2026-06-12 |
Β
Mandatory items
Checklist UI | Markdown |
|---|---|
Β | -! 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 |
|---|---|
- item todo
> piece of information
> that is useful for new ppl
> on how to complete an item
> even `with` **markdown** *support* |
Bullet points and Lists
You can make your checklist item details as a list or add bullet points:
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 |
|---|---|
Β | - http://google.com
- [link to google](http://google.com |
Β
Jira Issues Links
Checklist UI | Markdown |
|---|---|
Β | - https://jira.atlassian.net/browse/RVCH-32 |
Β
Emojis π
Start typing : to access emojis:
Checklist UI | Markdown |
|---|---|
Β | - Emoji :heart:
- Emoji :grinning:
- Emoji :white_check_mark: |
Β
Images
Checklist UI | Markdown |
|---|---|
- Β |
Β
Display text in [ ]
Markdown | Checklist UI |
|---|---|
~ \[Text in brackets\] | Β |