This cheatsheet provides a quick reference for Markdown syntax, making it easier to create and edit documents on GitHub.
It is designed for the WordPress Community Handbooks, therefore the options have been limited to a standard so that everyone does it as similarly as possible.
The H1 only must be used on the page title.
# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
###### Header 6View the example.
_Italic text_
**Bold text**
**_Bold and italic text_**
~~Strikethrough text~~View the example.
- Unordered list item
- Unordered list item
1. Ordered list item
2. Ordered list itemLists with nested elements:
* Item 1
* Item 2
* Item 3
* Item 3.1
* Item 3.2
* Item 3.3
1. Item 1
2. Item 2
3. Item 3
1. Item 3.1
2. Item 3.2
3. Item 3.3
1. Item 1
2. Item 2
3. Item 3
* Item 3.1
* Item 3.2
* Item 3.3View the example.
[Link text](https://example.com "Optional title")Links with code:
[`function()`](https://example.com/function "Function name")View the example.
View the example.
`Inline code` ```
Code block
```View the example.
> This is a blockquote.
>
> This is a continuation of the blockquote.View the example.
| Header 1 | Header 2 | Header 3 |
| -------- |:--------:| --------:|
| Text | Text | Text |
| More text| More text| More text|View the example.
---View the example.
This only works in GitHub. Shouldn't be use in documentation.
- [ ] Pending task
- [x] Completed task:emoji_name:You can find a complete list of supported emojis here.
The blue box.
[info]Some text.[/info]The green box.
[tip]Some text.[/tip]The yellow box.
[alert]Some text.[/alert]The red box.
[warning]Some text.[/warning]The purple box.
[tutorial]Some text.[/tutorial]Usually is not needed. A Code block shold be fine.
[php]<?php echo 'Hello World'; ?>[/php][html]<abbr title="World Wide Web Consortium">W3C</abbr>[/html]- →
- ←
- ↑
- ↓
- ↔
- ↕