1. FAQs & Technical Support | Nulab
  2. Backlog Support
  3. FAQs
  4. Formatting Rules & Shortcut Keys

Backlog 101: Github Flavored Markdown formatting rules

Backlog supports GitHub Flavored Markdown (GFM).

In this overview, we’ll cover the key GFM formatting rules supported in Backlog.

GitHub Flavored Markdown (GFM) formatting rules

The following can be used for issue or wiki pages:

Rule

Source

Result

Link to an issue,
Link to a wiki page

BLG-95,[[BLG-98]],[[WikiPageName]]

Screenshot 2025-09-23 at 11.10.11.png

Bold

''Bold''

Bold

Italic

'''Italic'''

Italic

Strike

%%Strike%%

Strike

Color

&color(#f00) { Color }
&color(red) { Color }
&color(#ffffff, #abd500) { Color }

Color
Color
Color

URL

https://backlog.com/
[[Backlog>https://backlog.com/]]
[[Backlog:https://backlog.com/]]

https://backlog.com/
Backlog
Backlog

Header

* Header1
** Header2
*** Header3

Screenshot 2025-09-23 at 11.23.45.png

Bulleted List

- Item-A
- Item-B
-- Item-B-1
--- Item-B-2-a
  • Item-A
  • Item-B
    • Item-B-1
      • Item-B-2-a

Numbered List

+ Item-A
+ Item-B
+ Item-C

Screenshot 2025-09-23 at 11.27.17.png

Table

| A | B | C |
|a|b|c|


|A|B|C|h
|a|b|c|
|d|e|f|


|~No.1|aaa|bbb|
|~No.2|ccc|ddd|
A B C
a b c

 

A B C
a b c
d e f

 

No.1 aaa bbb
No.2 ccc ddd

Quote

> Quote
> This is a paragraph

{quote}
Quote
This is a paragraph
{/quote}

Screenshot 2025-09-23 at 11.15.03.png

Code Macro

{code}
package helloworld;
public class Hello {
public String sayHello {
return "Hello";
 }
}
{/code}

Screenshot 2025-09-23 at 11.15.09.png

Link to a Subversion Revision

#rev(revision number)
e.g. #rev(11)
#rev(projectKey/revision number)
e.g. #rev(BLG/11)

 r11

Link to a Git Revision

#rev(repository:revision)
e.g. #rev(app:abcdeabcde)
#rev(projectKey/repository:revision)
e.g. #rev(BLG/app:abcdeabcde)

Screenshot 2025-09-23 at 11.17.30.png

Table of Contents

#contents

Screenshot 2025-09-23 at 11.17.35.png

Break

aaa&br;bbb

aaa

bbb

Insert an image (from other website)

#image(https://nulab.com/app/assets/img/common/backlog_logo.svg)

backlog logo

Insert a thumbnail (from other website)

#thumbnail(https://nulab.com/app/assets/img/common/backlog_logo.svg)

backlog logo

Escape a special letter

\\%\\%Not struck\\%\\%

|Using bars in table| \\|\\| |

%%Not struck%%

Using bars in table ||

 

The following can be used on wiki pages only:

Code Macro {code}
package helloworld;
public class Hello {
public String sayHello {
return "Hello";
 }
}
{/code}

code wiki.png

Cacoo diagram (Viewer)

This rule is inserted by toolbar's "Cacoo" button.

 #cacoo([path],[width],[height])
#cacoo([path],[width],[height],[theme])
#cacoo([path],[width],[height],[theme],[sheetNo])

(Please see help)

Show attached image file

This rule is inserted by toolbar's clip button.

 #image(id number of file)
e.g. #image(11)

Show attached image file

 #image(name of file)
e.g. #image(nulab.png)

Display thumbnail of attached image file

This rule is inserted by toolbar's clip button.

 #thumbnail(id number of file)
e.g. #thumbnail(11)

Display thumbnail of attached image file

 #thumbnail(name number of file)
e.g. #thumbnail(nulab.png)

Show link to attached file

This rule is inserted by toolbar's clip button.

 #attach(label for link:id number of file)
e.g. #attach(sample.zip:11)

sample.zip

 

4 people think that it is helpful. Was this helpful for you?

Related articles

Have a question we didn't answer?

Contact support