Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
branch: master
Fetching contributors…

Cannot retrieve contributors at this time

executable file 879 lines (697 sloc) 24.213 kb
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>MultiMarkdown Guide</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name = "viewport" content = "width = device-width"/>
<meta name = "viewport" content = "initial-scale = 1.0"/>
<link rel="stylesheet" href="http://yandex.st/highlightjs/7.3/styles/default.min.css">
<script src="http://yandex.st/highlightjs/7.3/highlight.min.js"></script>
<script>hljs.initHighlightingOnLoad();</script>
<link rel="stylesheet" type="text/css" media="screen" href="markdown-reference.css" />
<script type="text/javascript" src="javascripts/jquery-1.4.2.min.js"></script>
<script type="text/javascript" src="javascripts/guide.js"></script>
</head>
<body>
<h1 id="title">MultiMarkdown Guide</h1>
<h2 class="section-name">Text</h2>
<div class="section">
<table>
<tr>
<th>MultiMarkdown</th>
<th>Result</th>
</tr>
<tr>
<td>This text is **bold**.</td>
<td>This text is <strong>bold</strong>.</td>
</tr>
<tr>
<td>This text is also __bold__.</td>
<td>This text is also <strong>bold</strong>.</td>
</tr>
<tr>
<td>This text is *italicized*.</td>
<td>This text is <em>italicized</em>.</td>
</tr>
<tr>
<td>This text is also _italicized_.</td>
<td>This text is also <em>italicized</em>.</td>
</tr>
<tr>
<td>`This is some code.`</td>
<td><code class="no-highlight">This is some code.</code></td>
</tr>
<tr>
<td>&nbsp;&nbsp;&nbsp;&nbsp;This is a rather<br />
&nbsp;&nbsp;&nbsp;&nbsp;long section of code<br/>
&nbsp;&nbsp;&nbsp;&nbsp;taking multiple lines</td>
<td><code class="no-highlight">This is a rather<br />
long section of code<br />
taking multiple lines</code></td>
</tr>
</table>
</div>
<h2 class="section-name">Links</h2>
<div class="section">
<table>
<tr>
<th>MultiMarkdown</th>
<th>Result</th>
</tr>
<tr>
<td>Link to [Google](http://google.com).</td>
<td>Link to <a href="http://google.com">Google</a>.</td>
</tr>
<tr>
<td>Link to &lt;http://google.com&gt;.</td>
<td>Link to <a href="http://google.com">http://google.com</a>.</td>
</tr>
<tr>
<td>Link to [Google][] with attributes later in the document.<br />
<br />
Another Link to the [search engine][Google].<br /><br />
[Google]: http://google.com "The Google!" style="border: solid black 1px;" target="_blank"</td>
<td>
<p>Link to <a href="http://google.com" title="The Google!" style="border: solid black 1px;" target="_blank">Google</a> with attributes later in the document.</p>
<p>Another link to the <a href="http://google.com" title="The Google!" style="border: solid black 1px;" target="_blank">search engine</a>.</p>
</td>
</tr>
<tr>
<td>Send me an email at &lt;address@example.com&gt;.</td>
<td>Send me an email at <a href="mailto:address@example.com">address@example.com</a>.</td>
</tr>
</table>
</div>
<h2 class="section-name">Headings</h2>
<div class="section">
<table>
<tr>
<th>MultiMarkdown</th>
<th>Result</th>
</tr>
<tr>
<td># First Header</td>
<td><h1>First Header</h1></td>
</tr>
<tr>
<td>## Second Header ##</td>
<td><h2>Second Header</h2></td>
</tr>
<tr>
<td>### Third Header</td>
<td><h3>Third Header</h3></td>
</tr>
</table>
</div>
<h2 class="section-name">Blockquotes</h2>
<div class="section">
<table>
<tr>
<th>MultiMarkdown</th>
<th>Result</th>
</tr>
<tr>
<td>Here is the a normal paragraph.<br />
<br />
&gt; This is the first level of quoting.<br />
<br />
&gt;&gt; This is nested blockquote<br />
that runs onto the next line.<br />
<br />
&gt; Back to the first level.<br />
<br />
Notice the spaces when we start a new paragraph or separate the different blockquotes.</td>
<td>
<p>Here is the a normal paragraph.</p>
<blockquote>
<p>This is the first level of quoting.</p>
<blockquote>
<p>This is nested blockquote that runs onto the next line.</p>
</blockquote>
<p>Back to the first level.</p>
</blockquote>
<p>Notice the spaces when we start a new paragraph or separate the different blockquotes.</p>
</td>
</tr>
</table>
</div>
<h2 class="section-name">Images and Figures</h2>
<div class="section">
<table>
<tr>
<th>MultiMarkdown</th>
<th>Result</th>
</tr>
<tr>
<td>This is the simplest example of an ![image](mmd.png) embedded in a paragraph.</td>
<td>This is the simplest example of an <img src="mmd.png" alt="image" /> embedded in a paragraph.</td>
</tr>
<tr>
<td>This is an image example with a title attribute ![Alternate Message](mmd.png "This is a title") embedded in a paragraph.</td>
<td>This is an image example with a title attribute <img src="mmd.png" alt="Alternate Message" title="This is a title" /> embedded in a paragraph.</td>
</tr>
<tr>
<td>This is the same image ![image3][] but with the attributes placed later on in the document.<br />
<br />
[image3]: mmd.png "This is where the title goes" height=22px width=60px</td>
<td>This is the same image <img src="mmd.png" alt="image3" id="image3" title="This is where the title goes" style="height:22px;width:60px;" /> but with the attributes placed later on in the document.</td>
</tr>
<tr>
<td><p>When an image is placed in a paragraph by itself, it is wrapped in a &lt;figure&gt; tag.</p>
<p>![This is the figure caption][fig_id]</p><p> [fig_id]: mmd.png "This is where the title goes" height=45px width=120px</p></td>
<td><p>When an image is placed in a paragraph, it is wrapped in a &lt;figure&gt; tag.</p>
<figure>
<img src="mmd.png" alt="This is the figure caption" id="fig_id" title="This is where the title goes" style="height:45px;width:120px;" />
<figcaption>This is the figure caption</figcaption></figure>
</td>
</tr>
</table>
</div>
<h2 class="section-name">Lists</h2>
<div class="section">
<table>
<tr>
<th>MultiMarkdown</th>
<th>Result</th>
</tr>
<tr>
<td>
* Milk<br />
* Bread<br />
* Cheese<br />
&nbsp;&nbsp;* Cheddar<br />
&nbsp;&nbsp;* Camembert<br />
* Rice
</td>
<td>
<ul>
<li>Milk</li>
<li>Bread</li>
<li>Cheese
<ul>
<li>Cheddar</li>
<li>Camembert</li>
</ul>
</li>
<li>Rice</li>
</ul>
</td>
</tr>
<tr>
<td>
1. Milk<br />
2. Bread<br />
3. Cheese<br />
&nbsp;&nbsp;1. Cheddar<br />
&nbsp;&nbsp;2. Camembert<br />
4. Rice
</td>
<td>
<ol>
<li>Milk</li>
<li>Bread</li>
<li>Cheese
<ol>
<li>Cheddar</li>
<li>Camembert</li>
</ol>
</li>
<li>Rice</li>
</ol>
</td>
</tr>
</table>
</div>
<h2 class="section-name">Tables</h2>
<div class="section">
<table>
<tr>
<th>MultiMarkdown</th>
<th>Result</th>
</tr>
<tr>
<td>
Here is as example of [table][simple_table] followed by a more complex [example][reference_table] from the [documentation](https://github.com/fletcher/MultiMarkdown/wiki/MultiMarkdown-Syntax-Guide "MultiMarkdown Syntax Guide")<br />
<br />
<pre>
| First Header | Second Header | Third Header |
| :----------- | :-----------: | -------------------: |
| First row | Data | Very long data entry |
| Second row | **Cell** | *Cell* |
[simple_table]
</pre>
<pre>
| | Grouping ||
| First Header | Second Header | Third Header |
| ------------ | :-----------: | -----------: |
| Content | *Long Cell* ||
| Content | **Cell** | Cell |
| New section | More | Data |
[Prototype table][reference_table]
</pre>
</td>
<td>
<p>Here is as example of <a href="#simple_table">table</a> followed by a more complex <a href="#reference_table">example</a> from the <a href="https://github.com/fletcher/MultiMarkdown/wiki/MultiMarkdown-Syntax-Guide" title="MultiMarkdown Syntax Guide">documentation</a></p>
<table>
<caption id="simple_table">
simple_table
</caption>
<colgroup>
<col style="text-align:left;" />
<col style="text-align:center;" />
<col style="text-align:right;" />
</colgroup>
<thead>
<tr>
<th style="text-align:left;">First Header</th>
<th style="text-align:center;">Second Header</th>
<th style="text-align:right;">Third Header</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left;">First row</td>
<td style="text-align:center;">Data</td>
<td style="text-align:right;">Very long data entry</td>
</tr>
<tr>
<td style="text-align:left;">Second row</td>
<td style="text-align:center;"><strong>Cell</strong></td>
<td style="text-align:right;"><em>Cell</em></td>
</tr>
</tbody>
</table>
<table>
<caption id="reference_table">
Prototype table
</caption>
<colgroup>
<col style="text-align:left;" />
<col style="text-align:center;" />
<col style="text-align:right;" />
</colgroup>
<thead>
<tr>
<th style="text-align:left;"></th>
<th style="text-align:center;" colspan="2">Grouping</th>
</tr>
<tr>
<th style="text-align:left;">First Header</th>
<th style="text-align:center;">Second Header</th>
<th style="text-align:right;">Third Header</th>
</tr>
</thead>
<tbody>
<tr>
<td style="text-align:left;">Content</td>
<td style="text-align:center;" colspan="2"><em>Long Cell</em></td>
</tr>
<tr>
<td style="text-align:left;">Content</td>
<td style="text-align:center;"><strong>Cell</strong></td>
<td style="text-align:right;">Cell</td>
</tr>
</tbody>
<tbody>
<tr>
<td style="text-align:left;">New section</td>
<td style="text-align:center;">More</td>
<td style="text-align:right;">Data</td>
</tr>
</tbody>
</table>
</td>
</tr>
</table>
</div>
<h2 class="section-name">Footnotes</h2>
<div class="section">
<table>
<tr>
<th>MultiMarkdown</th>
<th>Result</th>
</tr>
<tr>
<td>Here is some text containing a footnote[^somesamplefootnote]. You can then continue your thought...<br />
<br />
[^somesamplefootnote]: Here is the text of the footnote itself.<br />
<br />
Even go to a new paragraph and the footnotes with go to the bottom of the document[^documentdetails].<br />
<br />
[^documentdetails]: Depending on the final form of your document, of course. See the documentation and experiment.<br/><br/>
&nbsp;&nbsp;&nbsp;&nbsp;This footnote has a second paragraph.</td>
<td>
<p>Here is some text containing a footnote<a href="#fn:1" id="fnref:1" title="see footnote" class="footnote">[1]</a>. You can then continue your thought…</p>
<p>Even go to a new paragraph and the footnotes with go to the bottom of the document<a href="#fn:2" id="fnref:2" title="see footnote" class="footnote">[2]</a>.</p>
<div class="footnotes">
<hr />
<ol>
<li id="fn:1">
<p>Here is the text of the footnote itself. <a href="#fnref:1" title="return to article" class="reversefootnote">&nbsp;↩</a></p>
</li>
<li id="fn:2">
<p>Depending on the final form of your document, of course. See the documentation and experiment.<a href="#fnref:2" title="return to article" class="reversefootnote">&nbsp;↩</a></p>
<p>This footnote has a second paragraph.</p>
</li>
</ol>
</div>
</td>
</tr>
<tr>
<td>This is an example of an inline footnote.[^This is the *actual* footnote.]</td>
<td>
<p>This is an example of an inline footnote.<a href="#fn:1" id="fnref:1" title="see footnote" class="footnote">[1]</a></p>
<div class="footnotes">
<hr />
<ol>
<li id="fn:1">
<p>This is the <em>actual</em> footnote. <a href="#fnref:1" title="return to article" class="reversefootnote">&#160;&#8617;</a></p>
</li>
</ol>
</div>
</td>
</tr>
</table>
</div>
<h2 class="section-name">Cross Reference</h2>
<div class="section">
<table>
<tr>
<th>MultiMarkdown</th>
<th>Result</th>
</tr>
<tr>
<td>You can place a link to a point in your document like this [one][], or [another][] place in the doc.<br />
<br />
## one ##<br />
<br />
A simple subheading in a larger document with the same name as the referring tag.<br />
<br />
## Another place in the document [another] ##<br />
<br />
Another place in the document that is referenced by the [another] tag in the heading<br /></td>
<td>
<p>You can place a link to a point in your document like this <a href="#one">one</a> or <a href="#another">another</a> place in the doc.</p>
<h2 id="one">one</h2>
<p>A simple subheading in a larger document with the same name as the referring tag.</p>
<h2 id="another">Another place in the document</h2>
<p>Another place in the document that is referenced by the [another] tag in the heading</p>
</td>
</tr>
</table>
</div>
<h2 class="section-name">Citations</h2>
<div class="section">
<table>
<tr>
<th>MultiMarkdown</th>
<th>Result</th>
</tr>
<tr>
<td>Let's cite a fake book.[p. 42][#fake]<br/>
<br/>
[#fake]: John Doe. *A Totally Fake Book*. Vanity Press, 2006.
</td>
<td><p>Let&#8217;s cite a fake book.<a class="citation" href="#fn:3" title="Jump to citation">[<span class="locator">p. 42</span>, 1]<span class="citekey" style="display:none">fake</span></a></p>
<div class="footnotes">
<hr />
<ol>
<li id="fn:3" class="citation"><span class="citekey" style="display:none">fake</span><p>John Doe. <em>A Totally Fake Book</em>. Vanity Press, 2006.</p>
</li>
</ol>
</div>
</td>
</tr>
</table>
</div>
<h2 class="section-name">Definition Lists</h2>
<div class="section">
<table>
<tr>
<th>MultiMarkdown</th>
<th>Result</th>
</tr>
<tr>
<td>
When you are making you definitions you should note the white space.
<pre>
Apple
: Pomaceous fruit of plants of the genus Malus in
the family Rosaceae.
Also the makers of really great products.
Banana
: 1. A delicious fruit that can be hazardous
if left on the ground.
2. A fruit that comes with it's own packaging
Orange
: The fruit of an evergreen tree of the genus Citrus.
</pre>
</td>
<td>
<p>When you are making you definitions you should note the white space.</p>
<dl>
<dt>Apple</dt>
<dd>
<p>Pomaceous fruit of plants of the genus Malus in the family Rosaceae.</p>
<p>Also the makers of really great products.</p>
</dd>
<dt>Banana</dt>
<dd>
<ol>
<li>
<p>A delicious fruit that can be hazardous if left on the ground.</p>
</li>
<li>
<p>A fruit that comes with it’s own packaging</p>
</li>
</ol>
</dd>
<dt>Orange</dt>
<dd>The fruit of an evergreen tree of the genus Citrus.</dd>
</dl>
</td>
</tr>
</table>
</div>
<h2 class="section-name">Math</h2>
<div class="section">
<table>
<tr>
<th>MultiMarkdown</th>
<th>Result</th>
</tr>
<tr>
<td>\\[ {e}^{i\pi }+1=0 \\]</td>
<td><math xmlns="http://www.w3.org/1998/Math/MathML" display="block">
<msup>
<mrow class="MJX-TeXAtom-ORD">
<mi>e</mi>
</mrow>
<mrow class="MJX-TeXAtom-ORD">
<mi>i</mi>
<mi>&#x03C0;<!-- π --></mi>
</mrow>
</msup>
<mo>+</mo>
<mn>1</mn>
<mo>=</mo>
<mn>0</mn>
</math></td>
</tr>
<tr>
<td>$${e}^{i\pi }+1=0$$</td>
<td><math xmlns="http://www.w3.org/1998/Math/MathML" display="block">
<msup>
<mrow class="MJX-TeXAtom-ORD">
<mi>e</mi>
</mrow>
<mrow class="MJX-TeXAtom-ORD">
<mi>i</mi>
<mi>&#x03C0;<!-- π --></mi>
</mrow>
</msup>
<mo>+</mo>
<mn>1</mn>
<mo>=</mo>
<mn>0</mn>
</math></td>
</tr>
<tr>
<td>A formula, \\( {e}^{i\pi }+1=0 \\), inside a paragraph.</td>
<td><p>A formula, <math xmlns="http://www.w3.org/1998/Math/MathML" display="inline">
<msup>
<mrow class="MJX-TeXAtom-ORD">
<mi>e</mi>
</mrow>
<mrow class="MJX-TeXAtom-ORD">
<mi>i</mi>
<mi>&#x03C0;<!-- π --></mi>
</mrow>
</msup>
<mo>+</mo>
<mn>1</mn>
<mo>=</mo>
<mn>0</mn>
</math>, inside a paragraph.</p></td>
</tr>
<tr>
<td>A formula, ${e}^{i\pi }+1=0$ , inside a paragraph. (Note space after the '$')</td>
<td><p>A formula, <math xmlns="http://www.w3.org/1998/Math/MathML" display="inline">
<msup>
<mrow class="MJX-TeXAtom-ORD">
<mi>e</mi>
</mrow>
<mrow class="MJX-TeXAtom-ORD">
<mi>i</mi>
<mi>&#x03C0;<!-- π --></mi>
</mrow>
</msup>
<mo>+</mo>
<mn>1</mn>
<mo>=</mo>
<mn>0</mn>
</math>, inside a paragraph.</p></td>
</tr>
<tr>
<td>x^2,y</td>
<td><p>x<sup>2</sup>,y</p></td>
</tr>
<tr>
<td>x^2,y^</td>
<td><p>x<sup>2,y</sup></p></td>
</tr>
<tr>
<td>x~z,y</td>
<td><p>x<sub>z</sub>,y</p></td>
</tr>
<tr>
<td>x~z,y~</td>
<td><p>x<sub>z,y</sub></p></td>
</tr>
</table>
</div>
<h2 class="section-name">Glossary</h2>
<div class="section">
<table>
<tr>
<th>MultiMarkdown</th>
<th>Result</th>
</tr>
<tr>
<td>Let's reference a glossary term.[^glossary]<br/><br/>
[^glossary]:glossary: Glossary
&nbsp;&nbsp;&nbsp;&nbsp;A section at the end ...</td>
<td><p>Let&#8217;s reference a glossary term.<a href="#fn:4" id="fnref:4" title="see footnote" class="footnote glossary">[1]</a></p>
<div class="footnotes">
<hr />
<ol>
<li id="fn:4">
<span class="glossary name">Glossary</span>: <p>A section at the end &#8230; <a href="#fnref:4" title="return to article" class="reversefootnote">&#160;&#8617;</a></p>
</li>
</ol>
</div>
</td>
</tr>
</table>
</div>
<h2 class="section-name">CriticMarkup</h2>
<div class="section">
<table>
<tr>
<th>MultiMarkdown</th>
<th>Result</th>
</tr>
<tr>
<td>This is {--is --}a test.</td>
<td><p>This is <del>is </del>a test.</p></td>
</tr>
<tr>
<td>This {++is ++}a test.</td>
<td><p>This <ins>is </ins>a test.</p></td>
</tr>
<tr>
<td>This {~~isn't~>is~~} a test.</td>
<td><p>This <del>isn&#8217;t</del><ins>is</ins> a test.</p></td>
</tr>
<tr>
<td>This is a {==test==}.</td>
<td><p>This is a <mark>test</mark>.</p></td>
</tr>
<tr>
<td>This is a test{>>What is it a test of?<<}.</td>
<td><p>This is a test.</p></td>
</tr>
</table>
</div>
<h2 class="section-name">Fenced Code Blocks</h2>
<div class="section">
<table>
<tr>
<th>MultiMarkdown</th>
<th>Result</th>
</tr>
<tr>
<td>```</br>
This is a fenced</br>
code block</br>
```</td>
<td><pre><code class="no-highlight">This is a fenced
code block
</code></pre></td>
</tr>
<tr>
<td>```perl</br>
# Demonstrate Syntax Highlighting if you link to highlight.js #</br>
# http://softwaremaniacs.org/soft/highlight/en/</br>
print "Hello, world!\n";</br>
$a = 0;</br>
while ($a < 10) {</br>
print "$a...\n";</br>
$a++;</br>
}</br>
```</td>
<td><pre><code class="perl"># Demonstrate Syntax Highlighting if you link to highlight.js #
# http://softwaremaniacs.org/soft/highlight/en/
print &quot;Hello, world!\n&quot;;
$a = 0;
while ($a &lt; 10) {
print &quot;$a...\n&quot;;
$a++;
}
</code></pre></td>
</tr>
</table>
</div>
<h2 class="section-name">Metadata Variables</h2>
<div class="section">
<table>
<tr>
<th>MultiMarkdown</th>
<th>Result</th>
</tr>
<tr>
<td>foo: bar</br>
</br>
Let's make a reference to [%foo]</td>
<td><p>Let&#8217;s make a reference to bar</p></td>
</table>
</div>
<h2 class="section-name">Acknowledgements</h2>
<div class="section" style="padding:10px;">
<p>MultiMarkdown Syntax Guide</p>
<blockquote>https://github.com/fletcher/human-markdown-reference</blockquote>
<p>Based on the Human Markdown Reference by Édouard Brière.</p>
<blockquote> https://github.com/edouard/human-markdown-reference</blockquote>
<p>Modified for MultiMarkdown syntax by the MMD Community.</p>
<p>For the first interaction examples were used from the following websites.</p>
<dl>
<dt>Byword:</dt>
<dd>http://bywordapp.com/markdown/guide.html</dd>
<dt>PHP Markdown Extra:</dt>
<dd>http://michelf.com/projects/php-markdown/extra</dd>
<dt>MultiMarkdown Guide:</dt>
<dd>https://github.com/fletcher/MultiMarkdown/blob/master/Documentation/MultiMarkdown%20User%27s%20Guide.md</dd>
</dl>
</div>
</body>
</html>
Jump to Line
Something went wrong with that request. Please try again.