Formatting Guide
Advanced Edit Options
The most advanced users can benefit from ACE Editor Keyboard Shortcuts
Smart Checklist for Jira is intended to make the process of checklists creation fast and handy.
On top of its own syntax, it supports basic Markdown features.
Checklists and Statuses
1
2
3
4
- item todo
+ item done
~ item in progress
x item cancelled |
NOTE: There should NOT be additional tabs or spaces at the beginning of the row. Otherwise, this block renders incorrectly!
If you have set up https://railsware.atlassian.net/wiki/spaces/CHKSDC/pages/2283044972/Custom+Statuses for your Jira instance - you can also use them in the checklist https://railsware.atlassian.net/wiki/spaces/CHKSDC/pages/2316861445/Full-Screen+Editor and https://railsware.atlassian.net/wiki/spaces/CHKSDC/pages/2350088359
Here’s an example:
1
2
- [IN QA] item that is IN QA status with Unchecked state
+ [QA FAILED] item that has QA FAILED state Checked stateRead more on https://railsware.atlassian.net/wiki/spaces/CHKSDC/pages/2283044972/Custom+Statuses
Headers
1
2
3
4
5
6
# Biggest heading
## Big heading
### Heading
#### Small heading
##### Smaller heading
###### Smallest heading | Biggest headingBig headingHeadingSmall headingSMALLER HEADINGSMALLEST HEADING |
NOTE: There should NOT be additional tabs or spaces at the beginning of the row. Otherwise, this block renders incorrectly!
Bullet points and Lists
1
2
3
4
5
6
* bullet point one
* bullet point two
> * bullet point nested
> * bullet point nested
1. list item one
2. list item two |
|
Emphasis
1
2
3
**bold text**
_italic text_
`emphasize` | bold text italic text emphasize |
Details per item
1
2
3
4
5
- item todo
> piece of information
> that is useful for new ppl
> on how to complete an item
> even `with` **markdown** *support* |
NOTE: There should NOT be additional tabs or spaces at the beginning of the row. Otherwise, this block renders incorrectly!
Highlight User or Date
1
2
3
4
5
6
7
@JD
@JohnDoe
@john.doe
10-03-2017
10/03/2017
2017/10/03
2017-03-10 |
Example
NOTE: user highlight (tagging, mentioning) will NOT trigger any notification for the mentioned user, as it works as a simple markup highlight on the Front End.
Links
1
[www.google.com](http://google.com) |
Images
1
 |
Extended markdown
For more details on Markdown formatting check Markdown support.
For any questions or feature requests contact us: smartchecklist@railsware.com
Sample Markup
How to convert a Slack message into a checklist using multi-line cursor feature