Show Menu

JIRA Text Formatting Notation Cheat Sheet by

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.
jira

Text Effects

*strong*
bold
_emphasis_
italic
??cita­tion??
Citation
-deleted-
stri­ket­hro­ugh
+inserted+
underlined
^supe­rsc­ript^
super­script
~subsc­ript~
subscript
{{monospace}}
monos­pac­e/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:
!quic­kti­me.m­ov!
!spac­eKe­y:p­age­Tit­le^­att­ach­men­t.mov!
!quic­kti­me.m­ov­|wi­dth­=30­0,h­eig­ht=40!
!medi­a.w­mv|­id=­media!
 

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­|th­umb­nail!
Insert a thumbnail of the image into the page.
!img.g­if­|al­ign­=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.
{pane­l:t­itle=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

Download the JIRA Text Formatting Notation Cheat Sheet

2 Pages
//media.cheatography.com/storage/thumb/rhorber_jira-text-formatting-notation.750.jpg

PDF (recommended)

Alternative Downloads

Share This Cheat Sheet!

 

Comments

No comments yet. Add yours below!

Add a Comment

Your Comment

Please enter your name.

    Please enter your email address

      Please enter your Comment.

          Related Cheat Sheets

          JIRA Cheat Sheet
          JQL (JIRA Query Language) Cheat Sheet