markdown5

Quick Markdown Syntax Guide

This guide shows you how to use Markdown instead of HTML when writing posts or comments.

Markdown is way easier to use than HTML. (But you can still use HTML at the same time if you really want to and you know how.)

Just write in the comment box the same way it’s shown in this file, it’s really that simple.

(See bottom for more info about Markdown itself.)


Headers

Just put 1 or more dashes or equals signs (— or ===) below the title.

This is a huge header

This is a huge header
==================

This is a smaller header

This is a smaller header
------------------

More ways of doing headers is using # characters at the beginning of the line:

You can use up to 6 # characters from <h1> to<h6>.
(You can optionally put them on the end, too, and they will disappear.)

This is a huge header

This is a smaller header

This is even smaller

More small

Even smaller
Smallest header

# This is a huge header #
## This is a smaller header ##
### This is even smaller ###
#### More small ####
##### Even smaller #####
###### Smallest header ######


Text

Use * or _ to emphasize things:

this is in italic and so is this using 1 * or _
*this is in italic*

this is in bold and so is this using 2 * or _
**this is in bold**

this is bold and italic and so is this using 3 * or _
***this is bold and italic***

You can use html markers for others:

Lorem ipsum dolor sit amet consectetur consectetur adipisicing elit.

Lorem ipsum dolor sit amet consectetur consectetur adipisicing elit.

Lorem ipsum dolor sit amet consectetur consectetur adipisicing elit.

Lorem ipsum dolor sit amet consectetur consectetur adipisicing elit.

Lorem ipsum dolor sit amet consectetur consectetur adipisicing elit.

Lorem ipsum dolor sit amet consectetur consectetur adipisicing elit.

Lorem ipsum dolor sit amet consectetur consectetur adipisicing elit.

Just write paragraphs like in a text file and they will display how you would expect. A blank line separates paragraphs.

So this is a new paragraph. But any text on adjacent lines will all end up in the same paragraph.

You can make manual break using tree space at the end of line:

So this is a new paragraph. But any text on adjacent lines
will all end up
in the same paragraph.


Lists

Numbered lists are automatically renumbered so their numbers start from one and are consecutive. If you don’t want this, precede the dot after the number with a backslash.

Unordered list

  • an asterisk starts an unordered list
  • another item in the list using *
  • or you can also use the + character
  • or the - character
    • A subitem, indented with 4 spaces
    • Another subitem item using +
    • Another subitem item using -
  • back to the first level

Ordered list

  1. A minimal numbered list
  2. Which is numbered
  3. With periods and a space
1. A minimal numbered list
1. Which is numbered
1. With periods and a space   

This is a mixed list:

  • first item unordered list
    with a paragraph.
  • second item unordered list
    with a paragraph.
    1. first numbered sub-list
      with a paragraph.
      • first item unordered sub-list
        with a paragraph.
      • second item unordered sub-list
    2. second item numbered sub-list
    3. third item numbered sub-list
  • third item unordered list
  • fourth item unordered list

Definitions

Apple
Pomaceous fruit of plants of the genius Malus in the family Rosaceae.
An American computer company.
Orange
The fruit of an evergreen tree of the genius Citrus.
Term 1
This is a definition with two paragraphs. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
Second definition for term 1, Aliquam hendrerit mi posuere lectus.
Term 2
Term 3
Two terms, one definition.

For a URL or email, just write it like this:

http://lemonde.fr

somebbob@example.com

basic link

The link can be completely define in the text with or without title attribute which will show up usually as a tooltip.

Here’s an inline link with tooltip Google and you can flight over the link to see the tooltip.
Here's an inline link with tooltip [Google](http://www.google.com/ "first rank search engine") and you can flight over the link to see the tooltip.

or ou can define them and use afterwards using link definition as follows:

[link name1]: http://www.example1.com "Optional title"
[link name2]: http://www.example2.com 'Optional title'
[link name3]: http://www.example3.com (Optional title)

Instead of double quotes also single quotes or parenthesis can be used for the title part.

Once defined, the link is “called” in the text as follows:

Lorem ipsum [link text][link name] dolor sit amet consectetur adipisicing elit.

If the link text and name are the same, also

[link name][] or even [link name]

The link definitions can appear anywhere in the document – before or after the place where you use them. The link definition names can be any unique string and are case-insensitive.

Example:
I get 10 times more traffic from this earch engine than from this one or this other.
I get 10 times more traffic from Google than from Yahoo or MSN.

I get 10 times more traffic from [this earch engine][Google] than from [this one][Yahoo] or [this other][MSN].
I get 10 times more traffic from [Google] than from [Yahoo] or [MSN].*
[google]: http://google.com/ "Google Search"
[yahoo]: http://search.yahoo.com/ "Yahoo Search"
[msn]: http://search.msn.com/ "MSN Search"


Blockquotes

Use the > character in front of a line, just like in email. Use it if you’re quoting a person, a song or whatever.

You can use italic or lists inside them also. And just like with other paragraphs, all of these lines are still part of the blockquote, even without the > character in front.

To end the blockquote, just put a blank line before the non blocknote following paragraph.

Blockquotes are like quoted text in email replies

And, they can be nested

And nested…

a new blockquote

title in block quote

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
list in block quote 1. first list item 1. second list item list in block quote – first list item – second list item

v2 for a new blockquote

title in block quote

list in block quote 1. first list item 1. second list item list in block quote – first list item – second list item


Tables

Table First Example

First Header Second Header
Content Cell Content Cell
Content Cell Content Cell

Table Second Example

Header Header Right
Cell Cell $10
Cell Cell $20

Table Third Example

Item Value
Computer $1600
Phone $12
Pipe $1

Table fourth Example

| | Spanning Header (Two Cells) ||

Header 1 Header 2 Header 2
Content 1 Spanning Cell
Content 2 Cell Bold Cell
New section More Data
And more And more

| Header1 | Header2 | Header3 | |:——–|:——-:|——–:| | cell1 | cell2 | cell3 | | cell4 | cell5 | cell6 | |—- | cell1 | cell2 | cell3 | | cell4 | cell5 | cell6 | |===== | Foot1 | Foot2 | Foot3 {: rules=”groups”}


Footnote Text

That’s some text with a footnote.1

Clicking this number2 will lead you to the second footnote.

That's some text with a footnote.[^footnote-test]

[^footnote-test]: And that's the footnote.

    That's the second paragraph of the footnote.
    (indented with 4 spaces).

Clicking this number[^another_footnote] will lead you to the second footnote.

[^another_footnote]: Handy! Now click the return link to go back.    
Test second paragraph using 4 spaces for manual break.<br />
or using html break `<br />`.

Preformatted Text

If you want some text to show up exactly as you write it, without Markdown doing anything to it, just indent every line by at least 4 spaces (or 1 tab).

This line won't *have any markdown* formatting applied.
I can even write <b>HTML</b> and it will show up as text.
This is great for showing program source code, or HTML or even Markdown.
<b>this won't show up as HTML</b> but exactly <i>as you see it in
this text file</i>.

(In a normal paragraph, this will show up in bold just like normal HTML.)

Remember, you have to indent by at least 4 spaces to do it. This paragraph won’t be preformatted.

<code> spans are delimited by backticks.

You can include literal backticks like `this`.

And if you use [reference][] links, make sure the links are indented by fewer than 4 spaces.

[reference]: http://example.com/blah 

(woops, that link didn’t work, see? It just got displayed as preformatted text.)

As a shortcut you can use backquotes to do the same thing while inside a normal paragraph. This won't be *italic* or **bold** at all.


Code

<script type="text/javascript">
<!-- to hide script contents from old browsers
document.write("Hello World!")
// end hiding contents from old browsers  -->
</script>

Manual Line Break

End a line with two or more spaces:

Roses are red,
Violets are blue.


Horizontal Rule

just put three or more *’s or -’s on a line:


or you can use single spaces between then, like this:


or


Make sure you have a blank line above the dashes, though, or else:

you will get a header


Images

To include an image, just put a “!” in front of a text link:

alternate text

The “alternate text” will show up if the browser can’t load the image.

You can also use a title if you want, like this:

tiny arrow

This is a formatted ![image][] and a [link][] with attributes.

[image]: http://cambelt.co/300×200 “300×200″ width=300px height=200px [link]: http://lemonde.fr “Some Link” class=external style=”border: solid black 1px;”


Escapes

What if you want to just show asterisks, not italics?

  • this shows up in italics: a happy day
  • this shows the asterisks: *a happy day*

The backslashes will disappear and leave the asterisks.

You can do the same with any of the characters that have a special meaning for Markdown.


HTML crap

Don’t worry about special HTML characters. I can write an ampersand & a less-than sign, and they show up as I intend them to: 3 < 4.

(You can still write &amp; (& character) and &lt; (<) or &gt; (>) if you want. or ignore what I just said.)


Accentuated characters

Dès Noël où un zéphyr haï me vêt de glaçons würmiens je dîne d’exquis rôtis de bœuf au kir à l’aÿ d’âge mûr & cætera !


Symbols

You can create the following symbols using a combination of characters:

“->” = “→” ; “<-” = “←” ; “<->” = “↔”
“(c)” = “©” ; “(r)” = “®” ; “(tm)” = ™
“<3″ = “♥ “
“x^2″ = “x²”

symbols -> symbols <- symbols <-> symbols (c) symbols (r) symbols ™ symbols <3 symbols x^2


Abbreviations {Abbreviations}

The HTML specification is maintained by the W3C.


About

This text file shows you how to use Markdown instead of crappy HTML when writing posts or comments.

Markdown is an easier way of making HTML pages from text, rather than having to know HTML.


Thanks

Thanks to John Gruber and Aaron Swartz for creating Markdown.

This is the Pookie Heading

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

End

No rights reserved, do with this what you like. Written by Greg Schueler, greg@vario.us

Documentation/Markdown Syntax.md

[TOC]

Here’s a poorly-named link. Never write “[click here]3“. Trust [me].


  1. And that’s the footnote.

    That’s the second paragraph of the footnote. (indented with 4 spaces). 

  2. Handy! Now click the return link to go back.
    Test second paragraph using 4 spaces for manual break.
    or using html break <br />

  3. http://www.w3.org/QA/Tips/noClickHere (Advice against the phrase “click here”) [me]: http://www.attacklab.net/ “Attacklab” 

markdown4

Quick Markdown Syntax Guide

This guide shows you how to use Markdown instead of HTML when writing posts or comments.

Markdown is way easier to use than HTML. (But you can still use HTML at the same time if you really want to and you know how.)

Just write in the comment box the same way it’s shown in this file, it’s really that simple.

(See bottom for more info about Markdown itself.)


Headers

Just put 1 or more dashes or equals signs (— or ===) below the title.

This is a huge header

This is a huge header
==================

This is a smaller header

This is a smaller header
------------------

More ways of doing headers is using # characters at the beginning of the line:

You can use up to 6 # characters from <h1> to<h6>.
(You can optionally put them on the end, too, and they will disappear.)

This is a huge header

This is a smaller header

This is even smaller

More small

Even smaller
Smallest header

# This is a huge header #
## This is a smaller header ##
### This is even smaller ###
#### More small ####
##### Even smaller #####
###### Smallest header ######


Text

Use * or _ to emphasize things:

this is in italic and so is this using 1 * or _
*this is in italic*

this is in bold and so is this using 2 * or _
**this is in bold**

this is bold and italic and so is this using 3 * or _
***this is bold and italic***

You can use html markers for others:

Lorem ipsum dolor sit amet consectetur consectetur adipisicing elit.

Lorem ipsum dolor sit amet consectetur consectetur adipisicing elit.

Lorem ipsum dolor sit amet consectetur consectetur adipisicing elit.

Lorem ipsum dolor sit amet consectetur consectetur adipisicing elit.

Lorem ipsum dolor sit amet consectetur consectetur adipisicing elit.

Lorem ipsum dolor sit amet consectetur consectetur adipisicing elit.

Lorem ipsum dolor sit amet consectetur consectetur adipisicing elit.

Just write paragraphs like in a text file and they will display how you would expect. A blank line separates paragraphs.

So this is a new paragraph. But any text on adjacent lines will all end up in the same paragraph.

You can make manual break using tree space at the end of line:

So this is a new paragraph. But any text on adjacent lines
will all end up
in the same paragraph.


Lists

Numbered lists are automatically renumbered so their numbers start from one and are consecutive. If you don’t want this, precede the dot after the number with a backslash.

Unordered list

  • an asterisk starts an unordered list
  • another item in the list using *
  • or you can also use the + character
  • or the - character
    • A subitem, indented with 4 spaces
    • Another subitem item using +
    • Another subitem item using -
  • back to the first level

Ordered list

Minimal
  1. A minimal numbered list
  2. Which is numbered
  3. With periods and a space
1. A minimal numbered list
1. Which is numbered
1. With periods and a space   
  1. A minimal numbered list

- Which is numbered - With periods and a space

1. A minimal numbered list
- Which is numbered
- With periods and a space   
Less minimal
  1. this starts a list with numbers

* will increment and show as number “2″ 11. any number, +, -, or * will keep the list going. * just indent by 4 spaces (or tab) to make a sub-list 1. keep indenting for more sub lists + one more item * here back to the second level * and to the first level.

stop list

  1. Stop by to see Anakin on Death Star
    1. Get a ride
    2. Wash robe

- Clean blood (and hand) off Anakin’s old light saber 1. Talk to Luke about his father 2. second item of the list – Skip the part where I leave him for dead – Don’t mention the youngling “thing” 3. Dinner with Yoda – Bring DEET – Bring Pepto – Dessert? – Wookie Pie 4. Submit restraining order against JarJar


Definitions

Apple
Pomaceous fruit of plants of the genius Malus in the family Rosaceae.
An American computer company.
Orange
The fruit of an evergreen tree of the genius Citrus.
Term 1
This is a definition with two paragraphs. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
Second definition for term 1, Aliquam hendrerit mi posuere lectus.
Term 2
Term 3
Two terms, one definition.

For a URL or email, just write it like this:

http://lemonde.fr

somebbob@example.com

basic link

The link can be completely define in the text with or without title attribute which will show up usually as a tooltip.

Here’s an inline link with tooltip Google and you can flight over the link to see the tooltip.
Here's an inline link with tooltip [Google](http://www.google.com/ "first rank search engine") and you can flight over the link to see the tooltip.

or ou can define them and use afterwards using link definition as follows:

[link name1]: http://www.example1.com "Optional title"
[link name2]: http://www.example2.com 'Optional title'
[link name3]: http://www.example3.com (Optional title)

Instead of double quotes also single quotes or parenthesis can be used for the title part.

Once defined, the link is “called” in the text as follows:

Lorem ipsum [link text][link name] dolor sit amet consectetur adipisicing elit.

If the link text and name are the same, also

[link name][] or even [link name]

The link definitions can appear anywhere in the document – before or after the place where you use them. The link definition names can be any unique string and are case-insensitive.

Example:
I get 10 times more traffic from this earch engine than from this one or this other.
I get 10 times more traffic from Google than from Yahoo or MSN.

I get 10 times more traffic from [this earch engine][Google] than from [this one][Yahoo] or [this other][MSN].
I get 10 times more traffic from [Google] than from [Yahoo] or [MSN].*
[google]: http://google.com/ "Google Search"
[yahoo]: http://search.yahoo.com/ "Yahoo Search"
[msn]: http://search.msn.com/ "MSN Search"


Blockquotes

Use the > character in front of a line, just like in email. Use it if you’re quoting a person, a song or whatever.

You can use italic or lists inside them also. And just like with other paragraphs, all of these lines are still part of the blockquote, even without the > character in front.

To end the blockquote, just put a blank line before the non blocknote following paragraph.

Blockquotes are like quoted text in email replies

And, they can be nested

And nested…

a new blockquote

title in block quote

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
list in block quote 1. first list item 1. second list item list in block quote – first list item – second list item

v2 for a new blockquote

title in block quote

list in block quote 1. first list item 1. second list item list in block quote – first list item – second list item


Tables

Table First Example

First Header Second Header
Content Cell Content Cell
Content Cell Content Cell

Table Second Example

Header Header Right
Cell Cell $10
Cell Cell $20

Table Third Example

Item Value
Computer $1600
Phone $12
Pipe $1

Table fourth Example

| | Spanning Header (Two Cells) ||

Header 1 Header 2 Header 2
Content 1 Spanning Cell
Content 2 Cell Bold Cell
New section More Data
And more And more

| Header1 | Header2 | Header3 | |:——–|:——-:|——–:| | cell1 | cell2 | cell3 | | cell4 | cell5 | cell6 | |—- | cell1 | cell2 | cell3 | | cell4 | cell5 | cell6 | |===== | Foot1 | Foot2 | Foot3 {: rules=”groups”}


Footnote Text

That’s some text with a footnote.1

Clicking this number2 will lead you to the second footnote.

That's some text with a footnote.[^footnote-test]

[^footnote-test]: And that's the footnote.

    That's the second paragraph of the footnote.
    (indented with 4 spaces).

Clicking this number[^another_footnote] will lead you to the second footnote.

[^another_footnote]: Handy! Now click the return link to go back.    
Test second paragraph using 4 spaces for manual break.<br />
or using html break `<br />`.

Preformatted Text

If you want some text to show up exactly as you write it, without Markdown doing anything to it, just indent every line by at least 4 spaces (or 1 tab).

This line won't *have any markdown* formatting applied.
I can even write <b>HTML</b> and it will show up as text.
This is great for showing program source code, or HTML or even Markdown.
<b>this won't show up as HTML</b> but exactly <i>as you see it in
this text file</i>.

(In a normal paragraph, this will show up in bold just like normal HTML.)

Remember, you have to indent by at least 4 spaces to do it. This paragraph won’t be preformatted.

<code> spans are delimited by backticks.

You can include literal backticks like `this`.

And if you use [reference][] links, make sure the links are indented by fewer than 4 spaces.

[reference]: http://example.com/blah 

(woops, that link didn’t work, see? It just got displayed as preformatted text.)

As a shortcut you can use backquotes to do the same thing while inside a normal paragraph. This won't be *italic* or **bold** at all.


Code

<script type="text/javascript">
<!-- to hide script contents from old browsers
document.write("Hello World!")
// end hiding contents from old browsers  -->
</script>

Manual Line Break

End a line with two or more spaces:

Roses are red,
Violets are blue.


Horizontal Rule

just put three or more *’s or -’s on a line:


or you can use single spaces between then, like this:


or


Make sure you have a blank line above the dashes, though, or else:

you will get a header


Images

To include an image, just put a “!” in front of a text link:

alternate text

The “alternate text” will show up if the browser can’t load the image.

You can also use a title if you want, like this:

tiny arrow

This is a formatted ![image][] and a [link][] with attributes.

[image]: http://cambelt.co/300×200 “300×200″ width=300px height=200px [link]: http://lemonde.fr “Some Link” class=external style=”border: solid black 1px;”


Escapes

What if you want to just show asterisks, not italics?

  • this shows up in italics: a happy day
  • this shows the asterisks: *a happy day*

The backslashes will disappear and leave the asterisks.

You can do the same with any of the characters that have a special meaning for Markdown.


HTML crap

Don’t worry about special HTML characters. I can write an ampersand & a less-than sign, and they show up as I intend them to: 3 < 4.

(You can still write &amp; (& character) and &lt; (<) or &gt; (>) if you want. or ignore what I just said.)


Accentuated characters

Dès Noël où un zéphyr haï me vêt de glaçons würmiens je dîne d’exquis rôtis de bœuf au kir à l’aÿ d’âge mûr & cætera !


Symbols

You can create the following symbols using a combination of characters:

“->” = “→” ; “<-” = “←” ; “<->” = “↔”
“(c)” = “©” ; “(r)” = “®” ; “(tm)” = ™
“<3″ = “♥ “
“x^2″ = “x²”

symbols -> symbols <- symbols <-> symbols (c) symbols (r) symbols ™ symbols <3 symbols x^2


Abbreviations {Abbreviations}

The HTML specification is maintained by the W3C.


About

This text file shows you how to use Markdown instead of crappy HTML when writing posts or comments.

Markdown is an easier way of making HTML pages from text, rather than having to know HTML.


Thanks

Thanks to John Gruber and Aaron Swartz for creating Markdown.

This is the Pookie Heading

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

End

No rights reserved, do with this what you like. Written by Greg Schueler, greg@vario.us

Documentation/Markdown Syntax.md

[TOC]

Here’s a poorly-named link. Never write “[click here]3“. Trust [me].


  1. And that’s the footnote.

    That’s the second paragraph of the footnote. (indented with 4 spaces). 

  2. Handy! Now click the return link to go back.
    Test second paragraph using 4 spaces for manual break.
    or using html break <br />

  3. http://www.w3.org/QA/Tips/noClickHere (Advice against the phrase “click here”) [me]: http://www.attacklab.net/ “Attacklab” 

markdown3

Header 1

Header 2

Header 3 ### (Hashes on right are optional)

Header 4

Header 5

Markdown plus h2 with a custom ID

Link back to H2

This is a paragraph, which is text surrounded by whitespace. Paragraphs can be on one line (or many), and can drone on for hours.

Here is a Markdown link to Warped, and a literal http://link.com/. Now some SimpleLinks, like one to [google] (automagically links to are-you- feeling-lucky), a [wiki: test] link to a Wikipedia page, and a link to [foldoc: CPU]s at foldoc.

Now some inline markup like italics, bold, and code(). Note that underscores in words are ignored in Markdown Extra.

picture alt

Blockquotes are like quoted text in email replies

And, they can be nested

  • Bullet lists are easy too
  • Another one
  • Another one
  1. A numbered list
  2. Which is numbered
  3. With periods and a space “
  4. A numbered list
    • Bullet lists are easy too
    • Bullet lists are easy too
  5. Which is numbered 1. Which is numbered 1. Which is numbered
    • Bullet lists are easy too
    • Bullet lists are easy too
  6. With periods and a space
    • Bullet lists are easy too
    • Bullet lists are easy too
    • Bullet lists are easy too
    • Bullet lists are easy too

And now some code:

// Code is just text indented a bit
which(is_easy) to_remember();

// Markdown extra adds un-indented code blocks too if (this_is_more_code == true && !indented) { // tild wrapped code blocks, also not indented }

Text with
two trailing spaces
(on the right)
can be used
for things like poems

Horizontal rules


****

<div class=”custom-class” markdown=”1″> This is a div wrapping some Markdown plus. Without the DIV attribute, it ignores the block. </div>

Markdown plus tables

Header Header Right
Cell Cell $10
Cell Cell $20
  • Outer pipes on tables are optional
  • Colon used for alignment (right versus left)

Markdown plus definition lists

Bottled water
$ 1.25
$ 1.55 (Large)
Milk
Pop
$ 1.75
  • Multiple definitions and terms are possible
  • Definitions can include multiple paragraphs too

markdown2

Quick Markdown Syntax Guide

This guide shows you how to use Markdown instead of HTML when writing posts or comments.

Markdown is way easier to use than HTML. (But you can still use HTML at the same time if you really want to and you know how.)

Just write in the comment box the same way it’s shown in this file, it’s really that simple.

(See bottom for more info about Markdown itself.)

Links

For a URL or email, just write it like this:

http://someurl

somebbob@example.com

To use text for the link, write it like this.

You can add a title (which shows up under the cursor), like this.

Reference Links

You can also put the link URL below the current paragraph like this.

Here the text “link URL” gets linked to “http://url”, and the lines showing “1: http://url” won’t show anything.

Or you can use a shortcut reference, which links the text “shortcut” to the link named “shortcut” on the next paragraph.

Text

Use * or _ to emphasize things:

this is in italic and so is this

this is in bold and so is this

this is bold and italic and so is this

Just write paragraphs like in a text file and they will display how you would expect. A blank line separates paragraphs.

So this is a new paragraph. But any text on adjacent lines will all end up in the same paragraph.

Blockquotes

Use the > character in front of a line, just like in email. Use it if you’re quoting a person, a song or whatever.

You can use italic or lists inside them also. And just like with other paragraphs, all of these lines are still part of the blockquote, even without the > character in front.

To end the blockquote, just put a blank line before the following paragraph.

Preformatted Text

If you want some text to show up exactly as you write it, without Markdown doing anything to it, just indent every line by at least 4 spaces (or 1 tab).

This line won't *have any markdown* formatting applied.
I can even write <b>HTML</b> and it will show up as text.
This is great for showing program source code, or HTML or even Markdown.
<b>this won't show up as HTML</b> but exactly <i>as you see it in
this text file</i>.

(In a normal paragraph, this will show up in bold just like normal HTML.)

Remember, you have to indent by at least 4 spaces to do it. This paragraph won’t be preformatted.

And if you use [reference][] links, make sure the links are indented by fewer than 4 spaces.

[reference]: http://example.com/blah

(woops, that link didn’t work, see? It just got displayed as preformatted text.)

As a shortcut you can use backquotes to do the same thing while inside a normal pargraph. This won't be *italic* or **bold** at all.

Lists

  • an asterisk starts an unordered list
  • and this is another item in the list
  • or you can also use the + character
  • or the – character

To start an ordered list, write this:

  1. this starts a list with numbers

+ this will show as number “2″ + this will show as number “3.”

  1. any number, +, -, or * will keep the list going.
    • just indent by 4 spaces (or tab) to make a sub-list
      1. keep indenting for more sub lists
    • here i’m back to the second level

Headers

This is a huge header

this is a smaller header

Just put 1 or more dashes or equals signs (— or ===) below the title.

You might use the huge header at the very top of your text for a title or something (except weblog posts usually already have a title), and use the smaller header for subtitles or sections.

Horizontal Rule

just put three or more *’s or -’s on a line:


or you can use single spaces between then, like this:


or


Make sure you have a blank line above the dashes, though, or else:

you will get a header

Images

To include an image, just put a “!” in front of a text link:

alternate text

The “alternate text” will show up if the browser can’t load the image.

You can also use a title if you want, like this:

tiny arrow

Escapes

What if you want to just show asterisks, not italics?

  • this shows up in italics: a happy day
  • this shows the asterisks: *a happy day*

The backslashes will disappear and leave the asterisks.

You can do the same with any of the characters that have a special meaning for Markdown.

More Headers

More ways of doing headers:

this is a huge header

this is a smaller header

this is even smaller

more small

even smaller
smallest still: <h6> header

You can use up to 6 # characters at the beginning of the line.
(You can optionally put them on the end, too, and they will disappear.)

HTML crap

Don’t worry about special HTML characters. I can write an ampersand & a less-than sign, and they show up as I intend them to: 3 < 4.

(You can still write &amp; (& character) and &lt; (<) or &gt; (>) if you want. or ignore what I just said.)

About

This text file shows you how to use Markdown instead of crappy HTML when writing posts or comments.

Markdown is an easier way of making HTML pages from text, rather than having to know HTML.

Thanks

Thanks to John Gruber and Aaron Swartz for creating Markdown.

Fin

No rights reserved, do with this what you like. Written by Greg Schueler, greg@vario.us

Markdown1

Quick Markdown Syntax Guide

This guide shows you how to use Markdown instead of HTML when writing posts or comments.

Markdown is way easier to use than HTML. (But you can still use HTML at the same time if you really want to and you know how.)

Just write in the comment box the same way it’s shown in this file, it’s really that simple.

(See bottom for more info about Markdown itself.)


Headers

This is a huge header

This is a smaller header

Just put 1 or more dashes or equals signs (— or ===) below the title.

More ways of doing headers is using # characters at the beginning of the line:

This is a huge header <h1>

This is a smaller header <h2>

This is even smaller <h3>

More small <h4>

Even smaller <h5>
Smallest still: <h6> header

You can use up to 6 # characters.
(You can optionally put them on the end, too, and they will disappear.)

This is a huge header
==================

This is a smaller header
------------------

# This is a huge header `<h1>` #
## This is a smaller header `<h2>` ##
### This is even smaller `<h3>` ###
#### More small `<h4>` ####
##### Even smaller `<h5>` #####
###### Smallest still: `<h6>` header


Text

Use * or _ to emphasize things:

this is in italic and so is this using 1 * or _

this is in bold and so is this using 2 * or _

this is bold and italic and so is this using 3 * or _

this is strike through text

lorem ipsum

lorem ipsum

lorem ipsumSuperscript

lorem ipsumSubscript

lorem ipsum

Just write paragraphs like in a text file and they will display how you would expect. A blank line separates paragraphs.

So this is a new paragraph. But any text on adjacent lines will all end up in the same paragraph.

You can make manual break using tree space at the end of line:

So this is a new paragraph. But any text on adjacent lines
will all end up
in the same paragraph.


*this is in italic* and _so is this_ using 1 `*` or `_` **this is in bold** and __so is this__ using 2 `*` or `_` ***this is bold and italic*** and ___so is this___ using 3 `*` or `_` <s>this is strike through text</s> <del> lorem ipsum </del>

Lists

  • an asterisk starts an unordered list
  • and this is another item in the list
  • or you can also use the + character
  • or the - character
    • A subitem, indented with 4 spaces
    • Another idented item in a bulleted list
    • Another idented item in a bulleted list
  • Here’s another item

To start an ordered list, write this:

  1. A minimal numbered list
  2. Which is numbered
  3. With periods and a space

  4. this starts a list with numbers

+ this will show as number “2″ * this will show as number “3.” 9. any number, +, -, or * will keep the list going. * just indent by 4 spaces (or tab) to make a sub-list 1. keep indenting for more sub lists 2. one more item * here i’m back to the second level


Definitions

Apple
Pomaceous fruit of plants of the genus Malus in the family Rosaceae.
Orange
The fruit of an evergreen tree of the genus Citrus.
Term 1
This is a definition with two paragraphs. Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aliquam hendrerit mi posuere lectus. Vestibulum enim wisi, viverra nec, fringilla in, laoreet vitae, risus.
Second definition for term 1, also wrapped in a paragraph because of the blank line preceding it.
Term 2

This definition has a code block, a blockquote and a list.

code block.

block quote on two lines. 1. first list item 2. second list item


For a URL or email, just write it like this:

http://someurl

somebbob@example.com

To use text for the link, write it like this.

You can add a title (tooltip) (which shows up under the cursor), like this.

Simple links

There are three ways to write links. Each is easier to read than the last:

Here’s an inline link to Google. Here’s a reference-style link to Google. Here’s a very readable link to Yahoo!.

The link definitions can appear anywhere in the document — before or after the place where you use them. The link definition names (1 and Yahoo!) can be any unique string, and are case-insensitive; [Yahoo!] is the same as [YAHOO!].

Advanced links: Title attributes

You can also add a title attribute to a link, which will show up when the user holds the mouse pointer it. Title attributes are helpful if your link text is not descriptive enough to tell users where they’re going. (In reference links, you can use optionally parentheses for the link title instead of quotation marks.)

Here’s a poorly-named link. Never write “[click here]1“. Trust [me].

Advanced links: Bare URLs

You can write bare URLs by enclosing them in angle brackets:

My web site is at http://www.attacklab.net.

If you use this format for email addresses, Showdown will encode the address to make it harder for spammers to harvest. Try it and look in the HTML Output pane to see the results:

Humans can read this, but most spam harvesting robots can’t: me@privacy.net


You can also put the link URL below the current paragraph like this.

Here the text “link URL” gets linked to “http://url”, and the lines showing “1: http://url” won’t show anything.

Or you can use a shortcut reference, which links the text “shortcut” to the link named “shortcut” on the next paragraph.


Take me to pookie


Blockquotes

Use the > character in front of a line, just like in email. Use it if you’re quoting a person, a song or whatever.

You can use italic or lists inside them also. And just like with other paragraphs, all of these lines are still part of the blockquote, even without the > character in front.

To end the blockquote, just put a blank line before the following paragraph.

Blockquotes are like quoted text in email replies

And, they can be nested

And nested…


Tables

Table First Example

First Header Second Header
Content Cell Content Cell
Content Cell Content Cell

Table Second Example

Header Header Right
Cell Cell $10
Cell Cell $20

Table Third Example

Item Value
Computer $1600
Phone $12
Pipe $1

Table fourth Example

| | Spanning Header (Two Cells) ||

Header 1 Header 2 Header 2
Content 1 Spanning Cell
Content 2 Cell Bold Cell
New section More Data
And more And more


Footnote Text

That’s some text with a footnote.2


Preformatted Text

If you want some text to show up exactly as you write it, without Markdown doing anything to it, just indent every line by at least 4 spaces (or 1 tab).

This line won't *have any markdown* formatting applied.
I can even write <b>HTML</b> and it will show up as text.
This is great for showing program source code, or HTML or even Markdown.
<b>this won't show up as HTML</b> but exactly <i>as you see it in
this text file</i>.

(In a normal paragraph, this will show up in bold just like normal HTML.)

Remember, you have to indent by at least 4 spaces to do it. This paragraph won’t be preformatted.

<code> spans are delimited by backticks.

You can include literal backticks like `this`.

And if you use [reference][] links, make sure the links are indented by fewer than 4 spaces.

[reference]: http://example.com/blah 

(woops, that link didn’t work, see? It just got displayed as preformatted text.)

As a shortcut you can use backquotes to do the same thing while inside a normal paragraph. This won't be *italic* or **bold** at all.


Code

<script type="text/javascript">
<!-- to hide script contents from old browsers
document.write("Hello World!")
// end hiding contents from old browsers  -->
</script>

Manual Line Break

End a line with two or more spaces:

Roses are red,
Violets are blue.


Horizontal Rule

just put three or more *’s or -’s on a line:


or you can use single spaces between then, like this:


or


Make sure you have a blank line above the dashes, though, or else:

you will get a header


Images

To include an image, just put a “!” in front of a text link:

alternate text

The “alternate text” will show up if the browser can’t load the image.

You can also use a title if you want, like this:

tiny arrow

This is a formatted ![image][] and a [link][] with attributes.

[image]: http://cambelt.co/300×200 “300×200″ width=300px height=200px [link]: http://lemonde.fr “Some Link” class=external style=”border: solid black 1px;”


Escapes

What if you want to just show asterisks, not italics?

  • this shows up in italics: a happy day
  • this shows the asterisks: *a happy day*

The backslashes will disappear and leave the asterisks.

You can do the same with any of the characters that have a special meaning for Markdown.


HTML crap

Don’t worry about special HTML characters. I can write an ampersand & a less-than sign, and they show up as I intend them to: 3 < 4.

(You can still write &amp; (& character) and &lt; (<) or &gt; (>) if you want. or ignore what I just said.)


Accentuated characters

Dès Noël où un zéphyr haï me vêt de glaçons würmiens je dîne d’exquis rôtis de bœuf au kir à l’aÿ d’âge mûr & cætera !


Symbols

You can create the following symbols using a combination of characters:

“->” = “→” ; “<-” = “←” ; “<->” = “↔”
“(c)” = “©” ; “(r)” = “®” ; “(tm)” = ™
“<3″ = “♥ “
“x^2″ = “x²”

symbols -> symbols <- symbols <-> symbols (c) symbols (r) symbols ™ symbols <3 symbols x^2


Abbreviations {Abbreviations}

The HTML specification is maintained by the W3C.


About

This text file shows you how to use Markdown instead of crappy HTML when writing posts or comments.

Markdown is an easier way of making HTML pages from text, rather than having to know HTML.


Thanks

Thanks to John Gruber and Aaron Swartz for creating Markdown.

This is the Pookie Heading

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

End

No rights reserved, do with this what you like. Written by Greg Schueler, greg@vario.us

Documentation/Markdown Syntax.md

[TOC]


  1. http://www.w3.org/QA/Tips/noClickHere (Advice against the phrase “click here”) [me]: http://www.attacklab.net/ “Attacklab” 

  2. And that’s the footnote.

    That’s the second paragraph.