summaryrefslogtreecommitdiff
path: root/doc/syntax-guide.markdown
blob: 8b1324f06bf71df77f142f58e469af2557853f36 (plain)
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
Syntax Guide
============

Kanboard use the [Markdown syntax](http://en.wikipedia.org/wiki/Markdown) for comments or task descriptions.
Here are some examples:

Bold and italic
----------------

- Bold text: Use 2 asterisks or 2 underscores
- Italic text: Use 1 asterisk or 1 underscore

### Source
```
This **word** is very __important__.

And here, an *italic* word with one _underscore_.
```

### Result

This **word** is very __important__.

And here, an *italic* word with one _underscore_.

Unordered Lists
---------------

Unordered list can use asterisks, minuses or pluses.

### Source

```
- Item 1
- Item 2
- Item 3

or

* Item 1
* Item 2
* Item 3
```

### Result

- Item 1
- Item 2
- Item 3

Ordered lists
-------------

Ordered lists are prefixed by a number like that:

### Source

```
1. Do that first
2. Do this
3. And that
```

### Result

1. Do that first
2. Do this
3. And that

Links
-----

### Source

```
[My link title](http://kanboard.net/)

<http://kanboard.net>

```

### Result

[My link title](http://kanboard.net/)

<http://kanboard.net>

Source code
-----------

### Inline code

Use a backtick.

```
Execute this command: `tail -f /var/log/messages`.
```

### Result

Execute this command: `tail -f /var/log/messages`.

### Code blocks

Use 3 backticks with eventually the language name.

<pre>
<code class="language-markdown">```php
&lt;?php

phpinfo();

?&gt;
```
</code>
</pre>

### Result

```
<?php

phpinfo();

?>
```

Titles
------

### Source

```
# Title level 1

## Title level 2

### Title level 3
```