# fletcher/human-markdown-reference forked from edouard/human-markdown-reference

Switch branches/tags
Nothing to show
Fetching contributors…
Cannot retrieve contributors at this time
executable file 667 lines (528 sloc) 19.2 KB
 MultiMarkdown Guide

MultiMarkdown Guide

Text

MultiMarkdown Result
This text is **bold**. This text is bold.
This text is also __bold__. This text is also bold.
This text is *italicized*. This text is italicized.
This text is also _italicized_. This text is also italicized.
This is some code. This is some code.
This is a rather
long section of code
taking multiple lines
This is a rather
long section of code
taking multiple lines

MultiMarkdown Result

Another link to the search engine.

Send me an email at <address@example.com>. Send me an email at address@example.com.

MultiMarkdown Result

Blockquotes

MultiMarkdown Result
Here is the a normal paragraph.

> This is the first level of quoting.

>> This is nested blockquote
that runs onto the next line.

> Back to the first level.

Notice the spaces when we start a new paragraph or separate the different blockquotes.

Here is the a normal paragraph.

This is the first level of quoting.

This is nested blockquote that runs onto the next line.

Back to the first level.

Notice the spaces when we start a new paragraph or separate the different blockquotes.

Images and Figures

MultiMarkdown Result
This is the simplest example of an ![MultiMarkdown Composer Icon](app_icon.png) embedded in a paragraph. This is the simplest example of an embedded in a paragraph.
This is an image example with a title attribute ![Alternate Message](app_icon.png "This is a title") embedded in a paragraph. This is an image example with a title attribute embedded in a paragraph.
This is the same image ![image3][] but with the attributes placed later on in the document.

[image3]: app_icon.png "This is where the title goes" height=40px width=40px
This is the same image but with the attributes placed later on in the document.
When an image is placed in a paragraph, it is wrapped in a <figure> tag ![This is the figure caption][fig_id] [fig_id]: app_icon.png "This is where the title goes" height=80px width=80px

When an image is placed in a paragraph, it is wrapped in a <figure> tag

This is the figure caption

Lists

MultiMarkdown Result
* Milk
* Cheese
* Cheddar
* Camembert
* Rice
• Milk
• Cheese
• Cheddar
• Camembert
• Rice
1. Milk
3. Cheese
1. Cheddar
2. Camembert
4. Rice
1. Milk
3. Cheese
1. Cheddar
2. Camembert
4. Rice

Tables

MultiMarkdown Result
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")

| :----------- | :-----------: | -------------------: |
| First row    |      Data     | Very long data entry |
| Second row   |    **Cell**   |               *Cell* |
[simple_table]
|              | Grouping                    ||
| ------------ | :-----------: | -----------: |
| Content      | *Long Cell*                 ||
| Content      | **Cell**      | Cell         |
| New section  | More          | Data         |
| And more     | And more      |
[Prototype table][reference_table]

Here is as example of table followed by a more complex example from the documentation

simple_table
First row Data Very long data entry
Second row Cell Cell
Prototype table
Grouping
Content Long Cell
Content Cell Cell
New section More Data
And more And more

Footnotes

MultiMarkdown Result
Here is some text containing a footnote[^somesamplefootnote]. You can then continue your thought...

[^somesamplefootnote]: Here is the text of the footnote itself.

Even go to a new paragraph and the footnotes with go to the bottom of the document[^documentdetails].

[^documentdetails]: Depending on the final form of your document, of course. See the documentation and experiment.

This footnote has a second paragraph.

Here is some text containing a footnote[1]. You can then continue your thought…

Even go to a new paragraph and the footnotes with go to the bottom of the document[2].

1. Here is the text of the footnote itself.  ↩

2. Depending on the final form of your document, of course. See the documentation and experiment.

This footnote has a second paragraph. ↩

Cross Reference

MultiMarkdown Result
You can place a have a link to another point in your document like this [one][] or you can take you to [another][] place in the doc.

## one ##

A simple subheading in a larger document with the same name as the referring tag.

## Another place in the document [another] ##

Another place in the document that is referenced by the [another] tag in the heading

You can place a have a link to another point in your document like this one or you can take you to another place in the doc.

one

A simple subheading in a larger document with the same name as the referring tag.

Another place in the document

Another place in the document that is referenced by the [another] tag in the heading

Citations

MultiMarkdown Result
Let's cite a fake book.[p. 42][#fake]

[#fake]: John Doe. *A Totally Fake Book*. Vanity Press, 2006.

Let’s cite a fake book.[p. 42, 1]

1. John Doe. A Totally Fake Book. Vanity Press, 2006.

Definition Lists

MultiMarkdown Result
When you are making you definitions you should note the white space.
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.

When you are making you definitions you should note the white space.

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.

Math

MultiMarkdown Result
\${e}^{i\pi }+1=0 \$ e i π + 1 = 0

Glossary

MultiMarkdown Result
Let's reference a glossary term.[^glossary]

[^glossary]:glossary: Glossary     A section at the end ...

Let’s reference a glossary term.[1]

1. Glossary:

A section at the end …  ↩

Acknowledgement

Based on the Human Markdown Reference by Édouard Brière.

https://github.com/edouard/human-markdown-reference

Modified for MultiMarkdown syntax by the MMD Community.

For the first interaction I took examples from the following websites.

Byword:
http://bywordapp.com/markdown/guide.html
PHP Markdown Extra:
http://michelf.com/projects/php-markdown/extra
MultiMarkdown Guide:
https://github.com/fletcher/MultiMarkdown/blob/master/Documentation/MultiMarkdown%20User%27s%20Guide.md