Skip to content

Some reference for the WordPress.org Handbook Markdown

License

Notifications You must be signed in to change notification settings

javiercasares/wordpress-handbook-markdown

Repository files navigation

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

View the example .

Emphasis

 _ Italic text _
 ** Bold text **
 ** _ Bold and italic text _ **
 ~~ Strikethrough text ~~

View the example .

Lists

 - Unordered list item - Unordered list item one . Ordered list item two . Ordered list item

Lists with nested elements:

 * Item 1 * Item 2 * Item 3 * Item 3.1 * Item 3.2 * Item 3.3 one . Item 1 two . Item 2 three . Item 3 one . Item 3.1 two . Item 3.2 three . Item 3.3 one . Item 1 two . Item 2 three . Item 3 * Item 3.1 * Item 3.2 * Item 3.3

View the example .

Links

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

Links with code:

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

View the example .

Images

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

View the example .

Code

 ` Inline code `
  ```
 Code block
  ```

View the example .

Blockquotes

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

View the example .

Tables

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

View the example .

Horizontal Lines

 ---

View the example .

Task Lists

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

 -  [ ] Pending task -  [x] Completed task

Emojis

 :emoji_name:

You can find a complete list of supported emojis here .

Formatting (exclusive for WP.org Meta / P2)

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 ]

Other helpers

Arrows

About

Some reference for the WordPress.org Handbook Markdown

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published