Markdown Supported by Website
Markdown Guide
Markdown is a lightweight and easy-to-use syntax for styling all forms of writing on the GitHub platform.
Basic Formatting
-
Headers
# H1 ## H2 ### H3 #### H4 ##### H5 ###### H6
Result:
H1
H2
H3
H4
H5
H6
-
Bold
**Bold Text**
Result:
Bold Text
-
Italic
*Italic Text*
Result:
Italic Text
-
Strikethrough
~~Strikethrough Text~~
Result:
Strikethrough Text -
Bold and nested italic
**Bold _and_ Italic**
Result:
Bold and Italic
Links and Images
-
Links
[Brit Stops](https://www.britstops.com/)
Result:
-
Images

Result:
Lists
-
Unordered List
- Item 1 - Item 2 - Item 3
Result:
- Item 1
- Item 2
- Item 3
-
Ordered List
1. Item 1 2. Item 2 3. Item 3
Result:
- Item 1
- Item 2
- Item 3
-
Nested Lists
1. Item 1 - Subitem 1 - Subitem 2 2. Item 2 - Subitem 1 - Subitem 2
Result:
- Item 1
- Subitem 1
- Subitem 2
- Item 2
- Subitem 1
- Subitem 2
- Item 1
Blockquotes
> Blockquote Text
Blockquote Text
Horizontal Rule
```
---
```
Inline Code
`Inline Code`
Inline Code
Code Blocks
```
\```
Code Block
\```
```
In addition, you can specify a language after the initial three backticks to enable syntax highlighting in the block. For example:
```
\```python
def hello_world():
print("Hello, world!")
\```
```
```python
def hello_world():
print("Hello, world!")
```
Tables
```
Column 1 | Column 2 | Column 3 |
---|---|---|
Text | Text | Text |
```
Column 1 | Column 2 | Column 3 |
---|---|---|
Text | Text | Text |
Task Lists
```
- [x] Completed task
- [ ] Incomplete task
```
- [x] Completed task
- [ ] Incomplete task
Advanced Concepts
-
Alternative Header Syntax
This is an H1 ============= This is an H2 -------------
Result:
This is an H1
This is an H2
-
Line Breaks
In Markdown, you can create a line break using two spaces at the end of a line.
This is the first line. And this is the second line.
Result:
This is the first line.
And this is the second line. -
Horizontal Rules
You can create a horizontal rule with three hyphens, asterisks, or underscores.
--- *** ___
Result:
-
Forced Page Breaks
Forced page breaks are not a feature of the core Markdown specification. However, in some versions of extended Markdown, you can create a page break by inserting a form feed character (
\f
). -
Indenting in Lists
You can create multiple levels of hierarchy in lists using indentation. Each level of hierarchy requires an additional four spaces or one tab.
- Item 1 - Subitem 1 - Subitem 2 - Item 2 - Subitem 1 - Subsubitem 1
Result:
- Item 1
- Subitem 1
- Subitem 2
- Item 2
- Subitem 1
- Subsubitem 1
- Subitem 1
- Item 1
-
Escaping Characters
You can use the backslash to escape special characters and treat them as literal characters.
\*This text is not italicized\*
Result:
*This text is not italicized*
-
Reference-style Links
You can define links and then refer to them later in your document using a reference-style syntax. This can make your Markdown more readable, especially for complex links or if you're reusing the same link multiple times.
[Brit Stops][brit-stops] [brit-stops]: https://www.britstops.com/
Result:
-
HTML
If you need to, you can include raw HTML in your Markdown files. Most Markdown parsers will just pass the HTML through to the output as-is.
<span style="color:blue">This is blue text.</span>
Result (in an HTML-capable viewer):
This is blue text.