Skip to content

MarkdownSyntax

Tim Steinbach edited this page Aug 28, 2012 · 5 revisions

Markdown Syntax

This cheat sheet is taken directly from chapter 8 of Markdown By Example

Text

Headlines

Headline H1
===========

Headline H2
----------------

# Headline H1
## Headline H2
### Headline H3
#### Headline H4
##### Headline H5
###### Headline H6

becomes

Headline H1

Headline H2

Headline H1

Headline H2

Headline H3

Headline H4

Headline H5
Headline H6

Text emphases

_Emphasized text_
*Emphasized text*

__Strongly emphasized text__
**Strongly emphasized text**

becomes

Emphasized text Emphasized text

Strongly emphasized text Strongly emphasized text

Lists

Unordered lists

- Unordered
- List
- Items

+ Unordered
+ List
+ Items

* Unordered
* List
* Items

becomes

  • Unordered
  • List
  • Items
  • Unordered
  • List
  • Items
  • Unordered
  • List
  • Items

Ordered lists

1. Ordered
2. List
3. Items

becomes

  1. Ordered
  2. List
  3. Items

Images / Links

Images

![Alt Text](http://nequissimus.github.com/MarkdownByExample/wiki/img/MBE.png "Image title")

![Alt Text][Image ID]
[Image ID]: http://nequissimus.github.com/MarkdownByExample/wiki/img/MBE.png "Image title"

becomes

Alt Text

![Alt Text][Image ID] [Image ID]: http://nequissimus.github.com/MarkdownByExample/wiki/img/MBE.png "Image title"

Links

[Link Text](http://markdownbyexample.com/ "Link title")

[Link Text][Link ID]
[Link ID]: http://markdownbyexample.com/ "Link title"

becomes

Link Text

[Link Text][Link ID] [Link ID]: http://markdownbyexample.com/ "Link title"

Automatic links

<http://markdownbyexample.com/>

<Automatic@linktoemailaddress.com>

becomes

http://markdownbyexample.com/

Automatic@linktoemailaddress.com

Code

Code blocks

This
Code block
Is indented
By four spaces

becomes

This Code block Is indented By four spaces

Lines of code

`Line of code`

``Line of code that includes a ` character``

becomes

Line of code

Line of code that includes a ` character

End-Of-Block character

    Code Block 1 - Line 1
    Code Block 1 - Line 2
^        
    Code Block 2 - Line 1

becomes

Code Block 1 - Line 1
Code Block 1 - Line 2

Code Block 2 - Line 1

Markdown Syntax


Markdown

Standard Markdown

Markdown dialects / extensions

Software

Websites

  • Jekyll
  • Octopress
  • Beautiful Docs
  • PHP Markdown
  • Markdoc

Presentations

  • ShowOff
  • mdpress
  • MarkdownPresenter
  • landslide
  • ScalaSlide
Clone this wiki locally