Skip to content

Markdown Guide

Markdown is a text-to-HTML conversion tool for web writers. Markdown allows you to write using an easy-to-read, easy-to-write plain text format, then convert it to structurally valid XHTML (or HTML). source

Tips & Tricks

Create an anchor

source

<!--link-->
Take me to [pookie](##pookie)
<!--anchor-->
## pookie

Link

Notes: - the link must be lower case - replace space in title with -

Cheat Sheet

This is a quick summary of the Markdown syntax.

Markdown Rendered Output
Heading 1 
# Heading 1

Heading 1
Heading 2 
## Heading 2

Heading 2
Heading 3 
### Heading 3

Heading 3
Bold 
This is some **bold text**
 This is some bold text
Italic 
This is some *italic text*
 This is some italic text
Blockquotes 
> Kent.
> Where's the king?

> Gent.
> Contending with the
> fretful elements
Kent.
Where's the king?

Gent.
Contending with
the fretful elements
List 
 Milk
 Eggs
 Beers
    * Desperados
    * Heineken
 Ham
  • Milk
  • Eggs
  • Beers
    • Desperados
    • Heineken
  • Ham
Ordered list 
1. Introduction
2. Main topic
    1. First sub-topic
    2. Second sub-topic
3. Conclusion
  1. Introduction
  2. Main topic
    1. First sub-topic
    2. Second sub-topic
  3. Conclusion
Inline code 
This is `someJavaScript()`
 This is someJavaScript()
Code block 
Here's some JavaScript code:

```
function hello() {
    alert('hello');
}
```

Language is normally auto-detected,
but it can also be specified:

```sql
SELECT * FROM users;
DELETE FROM sessions;
```
 Here's some JavaScript code:

function hello() {
    alert('hello');
}

Language is normally auto-detected, but it can also be specified:

SELECT * FROM users;
DELETE FROM sessions;
Unformatted text 
Indent with a tab or 4 spaces
for unformatted text.

    This text will not be formatted:

    Robert'); DROP TABLE students;--
 Indent with a tab or 4 spaces for unformatted text.

This text will not be formatted:

Robert'); DROP TABLE students;--
Link 
This is detected as a link:

https://hello-there.org

And this is a link anchoring text content:

[Hello-There](https://hello-there.org)

And this is a link, with a title,
anchoring text content:

[Hello-There](https://hello-there.org "Z01P24 Hello-There promotion")
 This is detected as a link:

https://hello-there.org

And this is a link anchoring text content:

Hello-There

And this is a link, with a title,
anchoring text content:

Hello-There (hint: hover over the link)
Images 
![Joplin icon](https://git.io/JenGk)
 Here's Joplin icon
Horizontal Rule 
One rule:
***
Another rule:
---
 One rule:

Another rule:
Tables See below

Tables

Tables are created using pipes | and and hyphens -. This is a Markdown table:

Basic tables

First Header Second Header
Content Cell Content Cell
Content Cell Content Cell 
First Header | Second Header
-|-
Content Cell | Content Cell
Content Cell | Content Cell

~~Note that there must be at least 3 dashes separating each header cell.~~

align tables

Colons can be used to align columns:

Tables Are Cool
col 3 is right-aligned $1600
col 2 is centered $12 
| Tables        | Are           | Cool  |
| ------------- |:-------------:| -----:|
| col 3 is      | right-aligned | $1600 |
| col 2 is      | centered      |   $12 |

Test Anchor

top