1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
|
# Markdown Help
Markdown makes it easy to format messages. Type a message as you normally would, and use these rules to render it with special formatting.
## Text Style:
You can use either `_` or `*` around a word to make it italic. Use two to make it bold.
* `_italics_` renders as _italics_
* `**bold**` renders as **bold**
* `**_bold-italic_**` renders as **_bold-italics_**
* `~~strikethrough~~` renders as ~~strikethrough~~
## Code Block:
Create a code block by indenting each line by four spaces, or by placing ``` on the line above and below your code.
Example:
```
code block
```
Renders as:
```
code block
```
### Syntax Highlighting
To add syntax highlighting, type the language to be highlighted after the ``` at the beginning of the code block.
Supported languages are:
`diff, apache, makefile, http, json, markdown, javascript, css, nginx, objectivec, python, xml, perl, bash, php, coffee (CoffeeScript), cs (C#), cpp (C++), sql, go, ruby, java, ini, latex`
Example:
``` go
package main
import "fmt"
func main() {
fmt.Println("Hello, 世界")
}
```
Renders as:
``` go
package main
import "fmt"
func main() {
fmt.Println("Hello, 世界")
}
```
## In-line Code:
Create in-line monospaced font by surrounding it with backticks.
```
`monospace`
```
Renders as: `monospace`.
## Links:
Create labeled links by putting the desired text in square brackets and the associated link in normal brackets.
`[Check out Mattermost!](www.mattermost.com)`
Renders as: [Check out Mattermost!](www.mattermost.com)
## In-line Images
Create in-line images using an `!` followed by the alt text in square brackets and the link in normal brackets. Add hover text by placing it in quotes after the link.
```
and
[](https://travis-ci.org/mattermost/platform) [](https://github.com/mattermost/platform)
```
Renders as:
and
[](https://travis-ci.org/mattermost/platform) [](https://github.com/mattermost/platform)
## Emojis
Check out a full list of emojis [here](http://www.emoji-cheat-sheet.com/).
```
:smile: :+1: :sheep:
```
Renders as:
:smile: :+1: :sheep:
## Lines:
Create a line by using three `*`, `_`, or `-`.
`***` renders as:
***
## Block quotes:
Create block quotes using `>`.
`> block quotes` renders as:
> block quotes
## Lists:
Create a list by using `*` or `-` as bullets. Indent a bullet point by adding two spaces in front of it.
```
* list item one
* list item two
* item two sub-point
```
Renders as:
* list item one
* list item two
* item two sub-point
Make it an ordered list by using numbers instead:
```
1. Item one
2. Item two
```
Renders as:
1. Item one
2. Item two
## Tables:
Create a table by placing a dashed line under the header row and separating the columns with a pipe `|`. (The columns don’t need to line up exactly for it to work). Choose how to align table columns by including colons `:` within the header row.
```
| Left-Aligned | Center Aligned | Right Aligned |
| :------------ |:---------------:| -----:|
| Left column 1 | this text | $100 |
| Left column 2 | is | $10 |
| Left column 3 | centered | $1 |
```
Renders as:
| Left-Aligned | Center Aligned | Right Aligned |
| :------------ |:---------------:| -----:|
| Left column 1 | this text | $100 |
| Left column 2 | is | $10 |
| Left column 3 | centered | $1 |
## Headings:
Make a heading by typing # and a space before your title. For smaller headings, use more #’s.
```
# Large heading
## Smaller heading
### Even smaller heading
```
Renders as:
# Large Heading
## Smaller Heading
### Even smaller heading
Alternatively, for the large heading you can underline the text using `===`. For the smaller heading you can underline using `---`
```
Large Heading
=============
Smaller Heading
--------------
```
Renders as:
Large Heading
=============
Smaller Heading
--------------
|
