Markdown syntax quick reference

You're viewing Apigee Edge documentation.
View Apigee X documentation.

Format Markdown HTML

Headings

#Heading 1

<h1>Heading 1</h1>

Heading 1
-------------

## Heading 2

<h2>Heading 2</h2>

Heading 2
--------------

### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

<h3>Heading 3</h3>
<h4>Heading 4</h4>
<h5>Heading 5</h5>
<h6>Heading 6</h6>

Paragraphs

Paragraphs are separated by a blank line.

This is another paragraph.

<p>Paragraphs are separated by a blank line</p>
<p>This is another paragraph.</p>

Line break

Two spaces at the end of a line  

inserts a line break.

Two spaces at the end of a line  <br>
Inserts a line break.

Font

**bold**

__bold__

<strong>bold</strong>

*italic*

_italic_

<em>italic</em>

**_bold and italic_**

<strong><em>bold and italic</em></strong>

'monospace'

<code>monospace</code>

~~strikethrough~~

<s>strikethrough</s>

Link

 [Link text](http://www.example.com) <a href="http://www.example.com">Link text</a>
[Link text](/directory/page)
 <a href="/directory/page">Link text</a>
[Link text](#anchor) - link to anchor in same page.
 <a href="#anchor">Link text</a> - link to anchor in same page.
[Link text](page_url#anchor) - link to anchor in another page.
 <a href="page_url#anchor">Link text</a> - link to anchor in another page.
[Header](#header) - link to header with the text "Header" in same page.
 <a href="#header">Header</a> - link to a header in same page only if the header is defined with either id="header" in the <h> tag or <a name="header">
[Header text](header-text) - link to header with the text "Header text" in same page. Spaces and punctuation are replaced with "-". <a href="#header-text">Header Text</a> - link to a header in same page only if the header is defined with either<a name="header-text"> or id="header-text" in the header tag, for example <h2 id="header-text">Header text</h2>.

Image

![Alt-text](http://www.mycompany.com/image.png)

<img src="http://www.mycompany.com/image.png" alt="Alt-text">

Horizontal rule

---

<hr />

Ordered list

1. Item 1
2. Item 2
3. Item 3

1. Item 1
1. Item 2
1. Item 3

1. Item 1
8. Item 2
6. Item 3

<ol>
<li>Item 1</li>
<li>Item 2</li>
<li>Item 3</li>
</ol>

Unordered list

* Item
* Item
* Item

+ Item
+ Item
+ Item

- Item
- Item
- Item

<ul>
<li>Item</li>
<li>Item</li>
<li>Item</li>
</ul>

Table

| Column 1 | Column 2 | Column 3 |
| --------------| ------------ | ------------- |
| Row 1-1   | Row 1-2   | Row 1-3   |
| Row 2-1   | Row 2-2   | Row 2-3   |

<table>
 <tr>
    <th>Column 1</th>
    <th>Column 2</th>
    <th>Column 3</th>
 </tr>
 <tr>
   <td>Row 1-1</td>
     <td>Row 1-2</td>
     <td>Row 1-3</td>
  </tr>
  <tr>
     <td>Row 2-1</td>
     <td>Row 2-2</td>
     <td>Row 2-3</td>
  </tr>
</table>

Preformatted text block

'''

{
   Code block
}
'''

<pre>
{
    Code block
}
</pre>

Blockquote

> This is a blockquote
> with multiple lines.

<blockquote>
This is a blockquote
With multiple lines.
</blockquote>

Center

N/A

<p style="text-align:center" >centered text</p>