You can add some Markdown-formatted text to your comments and section descriptions in projects; making it easier to stylize and organize information.
Listed below are the supported Markdown syntax formats:
Bold
You can wrap your text with **
to make it bold.
Let's make "Baklava" **bold**
Italics
Use _
around your text to make it italics.
Who else would like to have some _baklava_?
Code
Add a code block by wrapping the text with `
.
Should Baklava be filled with `walnuts` or `pistachio`?
Placing 3 back-ticks ```
before and after the text will produce a multi-line code block.
```
function eatBaklava() {
if (chocolate) {
throwAway();
}
else {
munch();
}
}
```
Blockquote
>
character at the beginning of one or more lines will produce a blockquote.
Tuba's thoughts on Baklava:
>Baklava is a delicious dessert, especially when it is filled with chopped pistachio!
Unordered list
Add a -
character to one or more lines to produce a bullet list.
- Filo pastry
- Walnuts or pistachio
- Syrup
Ordered List
Lines starting with 1., 2. and so on will produce an ordered numbered list.
1. Filo pastry
2. Walnuts or pistachio
3. Syrup
Links
Text surrounded with square brackets []
followed by a URL surrounded by parentheses ()
will produce a link.
Let's go to eat baklava! [Baklavalovers](https://zpl.io/baklavalovers)