<?php include('HEADER.php'); ?>

<h1>Markdown Notes</h1>

<p>The is a summary of the official <a href="http://daringfireball.net/projects/markdown/syntax">Markdown syntax</a> document.</p>

<p>You can put real HTML anywhere in a Markdown document, but block-level elements (div, table, pre, p) need a blank line before and after. Also, markdown syntax inside HTML is not processed.</p>

<p>&amp; and &lt, (and many other special characters) are automatically translated to HTML entities (&amp;amp;).</p>

<p>Paragraphs are separated by blank lines.</p>

<p>Non-paragraph line breaks (&lt;br /&gt;) can be made by putting 2 spaces after the line.</p>

<pre>
Header H1
=========

Header H2
---------

# Header H1 #

## Header H2 ##

### Header H3 ###

#### Header H4 ####

&gt; A blockquote

&gt; &gt; A nested blockquote

* Bulleted list
* Bulleted list
* Bulleted list

1. Numbered list 1
2. Numbered list

&nbsp;&nbsp;&nbsp;&nbsp;Sub-paragraphs within list items must be indented 4 spaces.

2. Numbered list (actual numbers don't matter)

Use *single asterisks* or _underscores_ for &lt;em&gt;.

Use **double asterisks** or __doubled underscores__ for &lt;strong&gt;.

A horizontal rule:

---------------

`backticks` are for &lt;code&gt;.

&nbsp;&nbsp;&nbsp;&nbsp;Indent pre-formatted blocks 4 spaces.

The carrot-ed URL &lt;http://paulgorman.org&gt; will be hyperlinked.

[This](http://paulgorman.org) will be hyperlinked.

A link within the same document works like [this][foo], and links to the paragraph below.

[foo]: This is the target of a link withing the same document.

![Alt text](/path/to/img.jpg)

![Alt text](/path/to/img.jpg "Optional title")

</pre>

<p>Use a backslash to escape any literal character that's wrongly interpreted as markdown.</p>

<h2>Extensions</h2>

<p>Besides `markdown.pl`, a number of processors are available, like <a href="http://johnmacfarlane.net/pandoc/">Pandoc</a> and <a href="http://kramdown.rubyforge.org/">kramdown</a>. The other processors support extensions for the markdown syntax.</p>

<pre>
Definition lists are like this:

A term
: The definition

Another term
: Another definition
</pre>

<h3>Pandoc</h3>

<p>Pandoc outputs HTML like <code>pandoc -S5 input.txt -o output.html</code> (<code>-S</code> outputs dash and ellipses as entities, and <code>-5</code> generates HTML5 instead of 4), or LaTeX like <code>pandoc input.txt -o output.tex</code>. The <code>-s</code> option adds standard headers and footers to the output, rather than a fragment. The <code>-t</code> and <code>-f</code> explicitly specify the <i>to</i> and <i>from</i> formats, like <code>pandoc -f html -t makrdown input.html</code> to output HTML as markdown.</p>

<p>If no output file is specified, results go to <code>stdout</code>.</p>

<pre>
The --smart option converts straight quotes to curly quotes,
--- and -- to Em-dashes, and ... to ellipses.

&lt;!-- HTML comments work --&gt;

  Right     Left     Center     Default
-------     ------ ----------   -------
     12     12        12            12
    123     123       123          123
      1     1          1             1

Table:  Demonstration of simple table syntax.

Multi-line tables are also supported:

-------------------------------------------------------------
 Centered   Default           Right Left
  Header    Aligned         Aligned Aligned
----------- ------- --------------- -------------------------
   First    row                12.0 Example of a row that
                                    spans multiple lines.

  Second    row                 5.0 Here's another one. Note
                                    the blank line between
                                    rows.
-------------------------------------------------------------

Table: Here's the caption. It, too, may span
multiple lines.

Document header:

% title
% author(s) (separated by semicolons)
% date
</pre>
<h3>kramdown</h3>

<pre>
--- renders as an em-dash
-- renders as an en-dash
... renders as an ellipsis

{::comment}
A comment ignored by kramdown
{:/comment}

| Table header 1 | Table header 2 | Table header 3 | Table header 4 |
|:---------------|:--------------:|---------------:|----------------|
| left aligned   | center aligned | right aligned  | default align  |
</pre>

<?php include('../FOOTER.php'); ?>
