Markdown Syntax
Space supports Markdown syntax in:
Blog articles and comments
Issue descriptions and comments
Code review comments
Here is the syntax to follow:
Emphasis
Formatting | Entered text | Published text |
|---|---|---|
Bold |
| This text is bold |
Italic |
| This text is italic |
Strikethrough |
| Never mind |
Headings
Formatting | Entered text | Published text |
|---|---|---|
Level 1 heading |
|  |
Level 2 heading |
| |
Level 3 heading |
|
Links
Formatting | Entered text | Published text |
|---|---|---|
External link autoconverted |
| |
External link with alias |
|
Horizontal rules
Entered | Published |
|---|---|
|
|
|
|
Lists
Formatting | Entered text | Published text |
|---|---|---|
Unordered list | * Entry
* Entry
- Entry
- Entry |
|
Ordered list | 1. Entry
1. Entry
1. Entry |
|
Tables
Formatting | Entered | Published | ||||||
|---|---|---|---|---|---|---|---|---|
Not aligned | | Column header 1 | Column header 2 | | ---------------|----------------| | content 1 |content 2| | content 1 |content 2| |
| ||||||
Right aligned | | Column header 1 | Column header 2 | | --------------:|---------------:| | content 1 |content 2| | content 1 |content 2| |
|
Reply quotation
Formatting | Entered text | Published text |
|---|---|---|
Blockquotes (can be nested) | > Some text
> Some text
>> Some text
>>> Some text |  |
Code
Formatting | Entered text | Published text |
|---|---|---|
Code block | ```
someCode
someCode
``` | someCode
someCode |
Inline code |
|
|
Syntax highlighting
To add color to your code block, specify a language next to the opening backticks.
Formatting | Entered text | Published text |
|---|---|---|
Code block with highlighted syntax | ```javascript
var s = "Hi there!";
alert(s);
``` |  |
Images
Entered | Published |
|---|---|
|  |
Diagrams, flowcharts, Git graphs
Create visualisations directly from text using Mermaid syntax. Quickly add a diagram or chart to your document, chat message, or code review comment — anywhere Markdown is supported.
Write your diagram text inside a code block, adding mermaid to the opening backticks.
Type | Entered text | Rendered text |
|---|---|---|
Flowchart | ```mermaid
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
``` |  |
Pie chart | ```mermaid
pie title Cake Ingredients
"Eggs" : 4
"Flour" : 3
"Sugar" : 2
"Butter" : 1
``` |  |
Git (commits) diagram | ```mermaid
gitGraph
commit
commit
commit
branch feature
commit
commit
checkout main
commit
``` |  |