WordPress Handbook Markdown Quick Reference

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.

Headers

The H1 only must be used on the page title.

# Header 1
## Header 2
### Header 3
#### Header 4
##### Header 5
###### Header 6

Emphasis

_Italic text_
**Bold text**
**_Bold and italic text_**
~~Strikethrough text~~

Lists

- Unordered list item
- Unordered list item

1. Ordered list item
2. Ordered list item

Links

[Link text](https://example.com "Optional title")

Links with code:

[`function()`](https://example.com/function "Function name")

Images

![Alternative text](https://example.com/image.jpg "Optional title")

You can drag and drop images, and video

Markdown.drag.and.drop.mov

Note: Please include the Alternative text as seen above once the image is uploaded

Alt Text is important for those who use screen readers to understand your content.

Learn More about Alt Text

Code

`Inline code`

 ```
 Code block
 ```

Blockquotes

> This is a blockquote.
> 
> This is a continuation of the blockquote.

Tables

| Header 1 | Header 2 | Header 3 |
| -------- |:--------:| --------:|
| Text     | Text     | Text     |
| More text| More text| More text|

Horizontal Lines

---

Task Lists

This only works in GitHub. Shouldn't be usen in documentation.

- [ ] Pending task
- [x] Completed task

Emojis

:emoji_name:

You can find a complete list of supported emojis here.

Formatting

Info box

The blue box.

[info]Some text.[/info]

Tip box

The green box.

[tip]Some text.[/tip]

Alert box

The yellow box.

[alert]Some text.[/alert]

Warning box

The red box.

[warning]Some text.[/warning]

Tutorial box

The purple box.

[tutorial]Some text.[/tutorial]

PHP box

Usually is not needed. A Code block shold be fine.

[php]<?php echo 'Hello World'; ?>[/php]

HTML box

[html]<abbr title="World Wide Web Consortium">W3C</abbr>[/html]

moranjosep/wordpress-handbook-markdown