doc/markdown.md
# Markdown Help
Hopefully this documentation is helpful. -- [Christian Holtje](http://docwhat.org)
## Headers:
Headers are marked with a `#` prefix.
Example:
# this is a first level header
## this is a second level header
### this is a third level header
Output:
> # this is a first level header
> ## this is a second level header
> ### this is a third level header
## Emphasis
Markdown uses asterisks and underscores to indicate spans of emphasis.
Example:
Some of these words *are emphasized*.
Some of these words _are emphasized also_.
Use two asterisks for **strong emphasis**.
Or, if you prefer, __use two underscores instead__.
Output:
> Some of these words *are emphasized*.
> Some of these words _are emphasized also_.
>
> Use two asterisks for **strong emphasis**.
> Or, if you prefer, __use two underscores instead__.
## Lists ##
Unordered (bulleted) lists use asterisks, pluses, and hyphens (`*`,
`+`, and `-`) as list markers. These three markers are
interchangable. Note, because of this, you may need to use `--` to
start a line with a dash ("--") character.
Example:
* Candy.
* Gum.
* Booze.
Output:
>- Candy.
>- Gum.
>- Booze.
Ordered (numbered) lists use regular numbers, followed by periods, as
list markers.
Example:
1. Red
2. Green
3. Blue
Output:
>1. Red
>2. Green
>3. Blue
If you put blank lines between items, you'll get `<p>` tags for the
list item text. You can create multi-paragraph list items by indenting
the paragraphs by 4 spaces or 1 tab:
* A list item.
With multiple paragraphs.
* Another item in the list.
Output:
> * A list item.
> With multiple paragraphs.
> * Another item in the list.
### Links ###
Markdown supports two styles for creating links: *inline* and
*reference*. With both styles, you use square brackets to delimit the
text you want to turn into a link.
Inline-style links use parentheses immediately after the link text.
Example:
This is an [example link](http://example.com/).
Output:
> This is an [example link](http://example.com/).
Reference-style links allow you to refer to your links by names, which
you define elsewhere in your document:
I get 10 times more traffic from [Google][1] than from
[Yahoo][2] or [MSN][3].
[1]: http://google.com/ "Google"
[2]: http://search.yahoo.com/ "Yahoo Search"
[3]: http://search.msn.com/ "MSN Search"
Output:
> I get 10 times more traffic from [Google][1] than from
> [Yahoo][2] or [MSN][3].
>
> [1]: http://google.com/ "Google"
> [2]: http://search.yahoo.com/ "Yahoo Search"
> [3]: http://search.msn.com/ "MSN Search"
The title attribute is optional. Link names may contain letters,
numbers and spaces, but are *not* case sensitive:
I start my morning with a cup of coffee and
[The New York Times][NY Times].
[ny times]: http://www.nytimes.com/
Output:
>I start my morning with a cup of coffee and
>[The New York Times][NY Times].
>
>[ny times]: http://www.nytimes.com/
### Images ###
Image syntax is very much like link syntax.
Example:
Output:
> 
## Blockquotes
If you're quoting something, then using blockquotes is really helpful.
Example:
> Now is the time for all good men to come to.
>
> -- Pogo (Walt Kelly)
Output:
> > Now is the time for all good men to come to.
> >
> > -- Pogo (Walt Kelly)