# MultiMarkdown v6 Syntax 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 itext is also _italicized_.
| This itext is also italicized.
    `This is some code.`
| `This is some code.`
    	This is a longer
    	section of code
    	on multiple lines.
    This is a longer
    section of code
    on multiple lines.
    m^2
| m2
    x^2,y^
| x2,y
    x~z
| xz
    C~6~H~12~O~6~
| C6H12O6
    Escaped characters -- \&
| Escaped characters – &
    "smart quotes"
| “smart quotes”
    'smart quotes'
| ‘smart quotes’
    apostrophe's
| apostrophe’s
    en -- dash
| en – dash
    em --- dash
| em — dash
    ellipsis ...
| ellipsis …

## abbreviations

MultiMarkdown | Result
--- | ---
    HTML and HTML

    [>HTML]: Hypertext Markup Language
| Hypertext Markup Language (HTML) and HTML
    [>(HTML) Hypertext Markup Language] and HTML
| Hypertext Markup Language (HTML) and HTML

## blockquotes

MultiMarkdown | Result
--- | ---
    Regular text.

    > Blockquote
    > with two lines.
    And one more line.
    >> And a second level blockquote.
| Regular text. Blockquote with two lines. And one more line. And a second level blockquote.

## citations

MultiMarkdown | Result
--- | ---
    Cite a source.[p. 42][#source]

    [#source]: John Doe. *A Totally Fake Book*. Vanity Press, 2006.
| Cite a source.(p. 42, 1) John Doe. A Totally Fake Book. Vanity Press, 2006. ↩
    Cite a source.[p. 42][#John Doe. *A Totally Fake Book*. Vanity Press, 2006.]
| Cite a source.(p. 42, 1) John Doe. A Totally Fake Book. Vanity Press, 2006. ↩

## criticmarkup

MultiMarkdown | Result
--- | ---
    This {++is ++}a test.
| This is a test.
    This is {--is --}a test.
| This is is a test.
    This {~~isn't~>is~~} a test.
| This isn’t is a test.
    This is a {==test==}.
| This is a test.
    This is a test.{>>What is it a test of?<<}
| This is a test.What is it a test of?

## cross references

MultiMarkdown | Result
--- | ---
    # Intro #

    # Conclusion [fin] #

    Link to [Intro].

    Link to the [end][fin].
| # Intro # Conclusion Link to Intro. Link to the end.

## definition lists

MultiMarkdown | Result
--- | ---
    Apple
    :   Pomaceous fruit of plants of the genus Malus in
        the family Rosaceae.

        Also the makers of really great products.
| Apple Pomaceous fruit of plants of the genus Malus in the family Rosaceae. Also the makers of really great products.

## fenced code blocks

MultiMarkdown | Result
--- | ---
    ```
    This is a fenced
    code block.
    ```
    This is a fenced
    code block.
    ```perl
    # Demonstrate Syntax Highlighting if you link to highlight.js #
    # http://softwaremaniacs.org/soft/highlight/en/
    print "Hello, world!\n";
    $a = 0;
    while ($a < 10) {
    print "$a...\n";
    $a++;
    }
    ```
    # Demonstrate Syntax Highlighting if you link to highlight.js #
    # http://softwaremaniacs.org/soft/highlight/en/
    print "Hello, world!\n";
    $a = 0;
    while ($a < 10) {
    print "$a...\n";
    $a++;
    }

## footnotes

MultiMarkdown | Result
--- | ---
    Text.[^foot]

    [^foot]: This is a footnote.
| Text.1 This is a footnote. ↩
    Text.[^This is an inline footnote.]
| Text.1 This is an inline footnote. ↩

## glossary

MultiMarkdown | Result
--- | ---
    [?Glossary] is a glossary term.

    [?Glossary]: The glossary collects information about
    important terms used in your documemnt.
| Glossary is a glossary term. Glossary: The glossary collects information about important terms used in your documemnt. ↩
    [?(Glossary) The glossary collects information
    about important terms used in your documemnt]
    is a glossary term.
| Glossary is a glossary term. Glossary: The glossary collects information about important terms used in your documemnt ↩

## headings

MultiMarkdown | Result
--- | ---
    # H1 Header
| # H1 Header
    ## H2 Header ##
| ## H2 Header
    # Header with custom id [custom]
| # Header with custom id
    H1 Header
    =========
| # H1 Header
    H2 Header
    ---------
| ## H2 Header

## horizontal rules

MultiMarkdown | Result
--- | ---
    ---
    - - -
    ****
    * * * * * *
    ______
    _ _ _ _

## html blocks

MultiMarkdown | Result
--- | ---
    <div>*bar*</div>
| *bar*
    <div>
    *bar*
    </div>
| *bar*
    foo
    <div>
    *bar*
    </div>
| foo *bar*
    <div>
    *bar*

    </div>
| *bar*
    <div>

    *bar*

    </div>
| bar
    <del>*bar*</del>
| bar
    <del>
    *bar*
    </del>
| *bar*
    foo
    <del>
    *bar*
    </del>
| foo bar
    <del>
    *bar*

    </del>
| *bar*
    <del>

    *bar*

    </del>
| bar

## images

MultiMarkdown | Result
--- | ---
    Image - ![image](mmd.png)
| Image -
    Image with title - ![image](mmd.png "This is a title")
| Image with title -
    Image with attributes - ![image].

    [image]: mmd.png "This is a title" height=22px width=60px
| Image with attributes - .
    Image by itself becomes a figure.

    ![This is the caption][image]

    [image]: mmd.png "This is the title" height=45px width=120px
| Image by itself becomes a figure. This is the caption

## linebreaks

MultiMarkdown | Result
--- | ---
    foo
    bar
| foo bar
    foo
    bar
| foo bar
    foo\
    bar
| foo bar

## links

MultiMarkdown | Result
--- | ---
    Link to [MMD](http://fletcherpenney.net/mmd)
| Link to MMD
    Link to [MultiMarkdown][MMD].

    [MMD]: http://fletcherpenney.net/mmd
| Link to MultiMarkdown.
    Link to [MMD][].

    [MMD]: http://fletcherpenney.net/mmd
| Link to MMD.
    Link to [MMD].

    [MMD]: http://fletcherpenney.net/mmd
| Link to MMD.
    Link to [MMD].

    [MMD]: http://fletcherpenney.net/mmd style="border: solid black 1px;"
| Link to MMD.
    Link to <http://fletcherpenney.net/mmd>
| Link to http://fletcherpenney.net/mmd
    <foo@example.com>
| foo@example.com

## lists

MultiMarkdown | Result
--- | ---
    * one
    * two
    	* a
    	* b
    * three
| one two a b three
    1. one
    2. two
    	1. a
    	2. b
    3. three
| one two a b three

## math

MultiMarkdown | Result
--- | ---
    A formula, \\({e}^{i\pi }+1=0\\), inside a paragraph.
| A formula, \({e}^{i\pi }+1=0\), inside a paragraph.
    A formula, ${e}^{i\pi }+1=0$, inside a paragraph.
| A formula, \({e}^{i\pi }+1=0\), inside a paragraph.
    \\[{e}^{i\pi }+1=0\\]
| \[{e}^{i\pi }+1=0\]
    $${e}^{i\pi }+1=0$$
| \[{e}^{i\pi }+1=0\]

## metadata

MultiMarkdown | Result
--- | ---
     Title:	This is a title
     Author:	Fletcher T. Penney
     HTML Header:

     Content
| Content

## raw source

MultiMarkdown | Result
--- | ---
    `*foo*`{=html}
| *foo*
    ```{=html}
    *foo*
    ```
| *foo*
    ```{=*}
    *foo*
    ```
| *foo*
    `*foo*`{=latex}

## table of contents

MultiMarkdown | Result
--- | ---
    # Table of Contents #

    {{TOC}}

    # Intro #

    # Conclusion #
| # Table of Contents # Intro # Conclusion

## tables

MultiMarkdown | Result
--- | ---
    | foo | bar |
    | --- | --- |
    | foo | bar |
    | foo bar  ||
    [*caption*][id]
caption
foo | bar
--- | ---
foo | bar
foo bar
    | longer header | longer header| longer header |
    | ---: | :---: | :--- |
    | foo | bar | bat |

    | foo | bar | bat |
    [*caption*][id]
caption
longer header | longer header | longer header
--- | --- | ---
foo | bar | bat
foo | bar | bat

## transclusion

MultiMarkdown | Result
--- | ---
    {{filename.md}}
| This is the content of the file `filename.md`.
    {{filename.*}}
| This is the content of the file `filename.html`, since we are creating HTML.

## variables

MultiMarkdown | Result
--- | ---
     foo:	bar

     (Variables defined in metadata.)  [%foo]
| (Variables defined in metadata.) bar

## Acknowledgements

MultiMarkdown v6 Syntax Guide
by Fletcher T. Penney

Inspired by the Human Markdown Reference by Édouard Brière (including css)

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