The Markdown Guide

Daring Fireball: Original description

CommonMark: A strongly defined, highly compatible specification of Markdown; Source and List of CommonMark implementations

Hyperdeck: Beautiful Markdown Slides for iPad and Mac; Presentation Markdown

Awesome-Markdown

Cheat sheet

Headers (atx style)

# h1
## h2
### h3
#### h4
##### h5
###### h6

Headers (setext style)

Header 1
========
Header 2
--------

Blockquotes

> This is
> a blockquote
>
> > Nested
> > Blockquote

Unordered List

* Item 1
* Item 2
    * item 3a
    * item 3b

or

- Item 1
- Item 2

or

+ Item 1
+ Item 2

or

- [ ] Checkbox off
- [x] Checkbox on

Ordered List

1. Item 1
2. Item 2
    a. item 3a
    b. item 3b

Links

[link](http://google.com)
[link][google]
[google]: http://google.com
<http://google.com>

Emphasis

*italic*
_italic_
**bold**
__bold__
`inline code`
~~struck out~~

Horizontal line

Hyphens

---

Asterisks

***

Underscores

___

Code

```javascript
console.log("This is a block code")

```markdown
~~~css
.button { border: none; }


```markdown
    4 space indent makes a code block

inline code

`Inline code` has back-ticks around it

Tables

| Left column | Center column | Right column |
|:------------|:-------------:|-------------:|
| Cell 1      | Centered      | $1600        |
| Cell 2      | Cell 3        | $12          |

Simple style

Left column | Center column | Right column 
:---:|:---:|:---:
Cell 1 | Centered | $1600 
Cell 2 | Cell 3 | $12 

A markdown table generator: tableconvert.com

Images

![GitHub Logo](/images/logo.png)

![Alt Text](url)

Image with link

[![GitHub Logo](/images/logo.png)](https://github.com/)

[![Alt Text](image_url)](link_url)

Reference style

![alt text][/images/logo.png]

[logo]: /images/logo.png "Logo Title"

Backslash escapes

Characters Escape Description
\ \\ backslash
` \` backtick
* \* asterisk
_ \_ underscore
{} \{} curly braces
[] \[] square brackets
() \() parentheses
# \# hash mark
+ \+ plus sign
- \- minus sign (hyphen)
. \. dot
! \! exclamation mark


Tags: format   text   presentation  

Last modified 16 December 2024