Markdown Style Guide
Edit
Topics
Headings
# Heading h1 ## Heading h2 ### Heading h3 #### Heading h4 ##### Heading h5 ###### Heading h6
Note: h1 – h4 items will be automatically added to the Table of Contents.
Emphasis
Italics
Wrap text with a single _
for Italic text:
This is _italic text_.
Bold
Wrap text with double **
for Bold text:
This is **bold text**.
Strikethrough
Wrap text with double ~~
for ~~strikethrough~~ text:
This is ~~strikethrough~~ text.
Links
Wrap the title in square brackets [title]
immediately followed by the URL in (https://example.com)
:
[WordPress](https://wordpress.org/)
Blockquotes
Use >
for blockquotes, double >>
to further indent:
> Blockquote >> Indented Blockquote
Lists
Unordered Lists
Use -
for unordereed lists, and intent two spaces for list subitems:
- List - List - List - List
Ordered Lists
Use numbered items followed by a `.:
1. One 2. Two 3. Three
Horizontal Rules
Use ---
for a horizontal rules:
---
Tables
| A | B | | ----- | ----- | | Alpha | Bravo |
Example Code
Inline Code
Wrap inline code with single `\``
backticks:
``` This is `inline code` wrapped with backticks ```
When documenting an example, use the markdown `\``
code block to demarcate the beginning and end of the code sample:
Fenced Code Blocks
Javascript
```javascript var foo = function (bar) { return bar++; }; console.log(foo(5)); ```
JSON
```json { "firstName": "John", "lastName": "Smith", "address": { "streetAddress": "21 2nd Street", "city": "New York", "state": "NY", "postalCode": "10021-3100" }, "phoneNumbers": [ { "type": "home", "number": "212 555-1234" }, { "type": "office", "number": "646 555-4567" } ], "children": [], "spouse": null } ```
CSS
```css foo { padding: 5px; margin-right: 3px; } .bar { background-color: #f00; } ```
SCSS
```scss foo { padding: 5px; margin-right: 3px; } .bar { background-color: #f00; } ```
HTML
```html <span class="my-class">Example</span> ```
PHP
```php $array = array( "foo" => "bar", "bar" => "foo", ); ```
Markdown
```md This is _italic text_. This is **bold text**. ```