Markdown

Markdown blocks allow you to add Markdown using a what-you-see-is-what-you-get (WYSIWYG) editor, as shown below:
GFM editor
Instructions are written using GitHub-flavored Markdown. They support images, videos, LaTeX, and a number of other things, all of which are detailed in the other documentation pages in this section.
Additionally, you can use any project template or {{user.*}} template.
Basic Markdown Syntax
You can use the WYSIWYG editor to edit Markdown, or write Markdown yourself using GitHub-flavored Markdown.
Headers
The following is the Markdown Syntax for headers, with H1 being the largest size header and H3 being the smallest size header.
1
# H1
2
## H2
3
### H3
Copied!
Bold Text
For bold text, simply put two asterisks before and after the word/phrase you are trying to make bold.
1
**bold text**
Copied!
Italicized Text
Italicized text is very similar to bold text, however instead of two asterisks, italicized text requires only one.
1
*Italicized text*
Copied!
Ordered List
Markdown also supports ordered lists, to replicate the list below, the following syntax is required.
1.First Item
2.Second Item
3.Third Item
1
1. First Item
2
2. Second Item
3
3. Third Item
Copied!
Unordered List
The implementation of an unordered list is very similar to an ordered list, just replace the index number with a hyphen.
First Item
Second Item
Third Item
1
- First Item
2
- Second Item
3
- Third Item
Copied!
Code/Code Block
To implement inline code, simply put a ` before and after the text.
1
`inline code`
Copied!
Code blocks are very similar, instead of one `, three are used. A target language can be specified for code highlighting as well. Code blocks are what were used in showcasing the syntax for Markdown in this section of the documentation.
1
```c++
2
#include <iostream>
3
​
4
int main() {
5
    std::cout << "Hello World!" << std::endl;
6
    return 0;
7
}
8
```
Copied!
Link to a Website
To insert a link, the following syntax is used:
1
[title](https://www.example.com)
Copied!
​

Steps

Images

Last modified 1yr ago

Copy link

Contents

Basic Markdown Syntax