Markdown Style Guide 
Edit
Topics
Headings 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 Emphasis
Italics Italics
Wrap text with a single _ for Italic text:
This is _italic text_.
Bold Bold
Wrap text with double ** for Bold text:
This is **bold text**.
Strikethrough Strikethrough
Wrap text with double ~~ for ~~strikethrough~~ text:
This is ~~strikethrough~~ text.
Links Links
Wrap the title in square brackets [title] immediately followed by the URL in (https://example.com):
[WordPress](https://wordpress.org/)
Blockquotes Blockquotes
Use > for blockquotes, double >> to further indent:
> Blockquote >> Indented Blockquote
Lists Lists
Unordered Lists Unordered Lists
Use - for unordereed lists, and intent two spaces for list subitems:
- List - List - List - List
Ordered Lists Ordered Lists
Use numbered items followed by a `.:
1. One 2. Two 3. Three
Horizontal Rules Horizontal Rules
Use --- for a horizontal rules:
---
Tables Tables
| A | B | | ----- | ----- | | Alpha | Bravo |
Example Code Example Code
Inline Code Inline Code
Wrap inline code with `\`` 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 Fenced Code Blocks
Javascript Javascript
```javascript
var foo = function (bar) {
return bar++;
};
console.log(foo(5));
```
JSON 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
```css
foo {
padding: 5px;
margin-right: 3px;
}
.bar {
background-color: #f00;
}
```
SCSS SCSS
```scss
foo {
padding: 5px;
margin-right: 3px;
}
.bar {
background-color: #f00;
}
```
HTML HTML
```html <span class="my-class">Example</span> ```
PHP PHP
```php
$array = array(
"foo" => "bar",
"bar" => "foo",
);
```
Markdown Markdown
```md This is _italic text_. This is **bold text**. ```