JIRA Text Formatting Notation Cheat Sheet

A Software › Jira cheat sheet in English by rhorber

A quick reference of the possible text formatting options in Jira Descriptions and Comments. It's the content found in the Jira help, I just summed it up.

220,148 views 7,356 downloads 1 Mar 2018 History
3.7 avg · 0 ratings

Text Effects

*strong*
bold
_emphasis_
italic
??cita­tion??
Citation
-deleted-
strike­through
+inserted+
underlined
^super­script^
supers­cript
subscript
subscript
{{monospace}}
monosp­ace­/code
bq. Text
Block quote, like Cheato­gra­phy­'s Answer block
{quote}
quotable
paragraph
{quote}
Block quote a multiline paragraph
{color:red}
text
{color}
Text color

Links

[#anchor]
[^attachment.ext]
Internal link to an anchor or attachment
[http:­//e­xam­ple.com]
External link
[Alias­|ht­tp:­//...]
External link with alias
[mailt­o:f­oob­ar@­exa­mpl­e.com]
Email link, with icon
[file:­///­c:/­tmp­/fo­o.txt]
Download link to a file
{ancho­r:a­nch­orname}
Creates an anchor
[~user­name]
Link to user profile page

Text Breaks

(empty line)
Produces a new paragraph
\\
Creates a line break
----
Horizontal ruler
---
Long dash symbol
--
Dash symbol

Attach­ments

Some attach­ments of a specific type can be embedded into a wiki renderable field from attached files, taking in a comma-­sep­arated list of proper­ties:
!quick­tim­e.mov!
!space­Key­:pa­geT­itl­e^a­tta­chm­ent.mov!
!quick­tim­e.m­ov|­wid­th=­300­,he­igh­t=40!
!media.wm­v|i­d=m­edia!

Tables

||heading 1||heading 2||heading 3||
|col A1|col A2|col A3|
|col B1|col B2|col B3|
Makes a table. Use double bars for a table
heading row.

Lists

* some
* bullet
** indented
** bullets
* points
A bulleted list (must be in first column)
# a
# numbered
# list
A numbered list (must be in first column).
- different
- bullet
- types
List items (with -), several lines create a single list
Use more (**, ***; ##, ###) for deeper indent­ations. Bulleted and numbered lists can be mixed (#*, *#).

Headings

h1
Biggest heading
h2
Bigger heading
h3
Big heading
h4
Normal heading
h5
Small heading
h6
Smallest heading
To create a header, place "hn. " at the start of the line (where n can be a number from 1-6).

Images

!http://example.com/img.gif!
!attached-image.gif!
Inserts an image into the page.
!img.j­pg|­thu­mbnail!
Insert a thumbnail of the image into the page.
!img.g­if|­ali­gn=­right, vspace=4!
For any image, you can also specify attributes of the image tag as a comma separated list of name=value pairs like so.

Misc. (Icons­/em­oti­cons)

\x
Escape a character
:)
😊
:(
☹️
:P
😛
:D
😀
;)
😉
(y)
(n)
(i)
(blue)
(/)
(green)
(x)
❎ (red)
(!)
(yellow)
(+)
(green)
(-)
(red)
(?)
(blue)
(on)
(lit)
(off)
(off)
(*)
(yellow)
(*r)
(red)
(*g)
(green)
(*b)
(blue)
(*y)
(yellow)
(flag)
(red)
(flagoff)

Advanced Formatting

{noformat}
preformatted piece of text
so *no* further _forma­tting_ is done here
{noformat}
Prefor­matted text block with no syntax highli­ghting.
{code:title=Bar.java}
public String getFoo() {
  return foo;
}
{code}
Makes a prefor­matted block of code with syntax highli­ghting. Languages: Java (default), JavaSc­ript, Action­Script, XML, SQL.
{panel}
Some text
{panel}
Embraces a block of text within a fully custom­izable panel.
{panel­:ti­tle=My Title|borderStyle=dashed}
a block of text surrounded with a *panel*
{panel}
Panel with optional parame­ters.
The optional parameters you can define, for panel and code, are the following ones:
title, border­Style, border­Color, border­Width, bgColor, titleB­GColor

Badges

Useful Cheat Sheet Nice Cheat Sheet Good Cheat Sheet Downloaded from Unusual Locations × 2

Comments

No comments yet.

Cheatography n. The art of mapping complex subjects into clear, instantly navigable reference guides.