### Install MultiMarkdown

Source: http://fletcher.github.io/MultiMarkdown-5/MMD_Users_Guide.fodt

Install the compiled MultiMarkdown software using 'make install'. This command typically requires root privileges.

```bash
make install
```

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

### Install MultiMarkdown Scripts

Source: http://fletcher.github.io/MultiMarkdown-5/MMD_Users_Guide.fodt

Install helper scripts like 'mmd', 'mmd2tex', etc., using 'make install-scripts'.

```bash
make install-scripts
```

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

### Install MultiMarkdown on FreeBSD

Source: http://fletcher.github.io/MultiMarkdown-5/installation.html

Build and install MultiMarkdown from the FreeBSD ports tree.

```bash
cd /usr/ports/textproc/multimarkdown
make install
```

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

### Syntax Highlighter HTML Header Configuration

Source: http://fletcher.github.io/MultiMarkdown-5/fences.html

Example of metadata that can be used to configure syntax highlighting, typically by linking external CSS and JavaScript files. This setup may vary depending on the chosen highlighter.

```html
html header:    <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>
```

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

### Verify MultiMarkdown Installation

Source: http://fletcher.github.io/MultiMarkdown-5/using_mmd.html

Check the installed version of the MultiMarkdown tool.

```bash
multimarkdown -v
```

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

### CriticMarkup Highlighting Example

Source: http://fletcher.github.io/MultiMarkdown-5/syntax.html

Shows the CriticMarkup syntax for highlighting text. The text within {== ==} is marked for highlighting.

```text
This is a {==test==}.

```

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

### Install MultiMarkdown via Homebrew

Source: http://fletcher.github.io/MultiMarkdown-5/MMD_Users_Guide.fodt

Use Homebrew to install the latest stable version of MultiMarkdown on macOS. Ensure Homebrew is installed first.

```bash
brew install multimarkdown
```

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

### CriticMarkup Substitution Example

Source: http://fletcher.github.io/MultiMarkdown-5/syntax.html

Demonstrates the CriticMarkup syntax for substituting text. The format is {~~original~>new~~}, where 'original' is replaced by 'new'.

```text
This {~~isn't~>is~~} a test.

```

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

### CriticMarkup Addition Example

Source: http://fletcher.github.io/MultiMarkdown-5/syntax.html

Illustrates the CriticMarkup syntax for marking text to be added. The text within {++ ++} is considered an addition.

```text
This {++is ++}a test.

```

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

### Install MultiMarkdown via MacPorts

Source: http://fletcher.github.io/MultiMarkdown-5/installation.html

Install MultiMarkdown using the MacPorts package manager.

```bash
sudo port install multimarkdown
```

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

### Display Version

Source: http://fletcher.github.io/MultiMarkdown-5/using_mmd.html

Displays the version of MultiMarkdown currently installed.

```bash
multimarkdown -v, multimarkdown --version
```

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

### CriticMarkup Comment Example

Source: http://fletcher.github.io/MultiMarkdown-5/syntax.html

Illustrates the CriticMarkup syntax for adding comments. Comments are enclosed within {>> <<}.

```text
This is a test{>>What is it a test of?<<}.

```

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

### Install MultiMarkdown via Homebrew

Source: http://fletcher.github.io/MultiMarkdown-5/installation.html

Use Homebrew to install the stable or latest development version of MultiMarkdown on Mac OS.

```bash
brew install multimarkdown
```

```bash
brew install --HEAD multimarkdown
```

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

### Perl Syntax Highlighting Example

Source: http://fletcher.github.io/MultiMarkdown-5/fences.html

Demonstrates how to use fenced code blocks with a language specifier for syntax highlighting. Ensure highlight.js is linked for this to function.

```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++;
}
```

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

### OPML Hierarchical Level Example

Source: http://fletcher.github.io/MultiMarkdown-5/known_issues.html

Example of a MultiMarkdown structure that causes issues with OPML conversion due to skipped nesting levels.

```markdown
# First Level #

## Second Level  ##

### Third Level ###

## Another Second Level ##

#### Fourth Level ####

```

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

### Configure MathJax in MultiMarkdown

Source: http://fletcher.github.io/MultiMarkdown-5/math.html

Set up metadata for MathJax support in web pages. This includes linking to a MathJax installation and defining header/footer elements.

```markdown
latex input:    mmd-article-header  
Title:          MultiMarkdown Math Example  
latex input:    mmd-article-begin-doc  
latex footer:   mmd-memoir-footer  
HTML header:    <script type="text/javascript"
                src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
                </script>


An example of math within a paragraph --- \({e}^{i\pi }+1=0\)
--- easy enough.

And an equation on it's own:

\[ {x}_{1,2}=\frac{-b\pm \sqrt{{b}^{2}-4ac}}{2a} \]

That's it.
```

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

### Install Latest Development Version via Homebrew

Source: http://fletcher.github.io/MultiMarkdown-5/MMD_Users_Guide.fodt

Install the latest development version of MultiMarkdown using Homebrew on macOS. This is useful for accessing the newest features between releases.

```bash
brew install --HEAD multimarkdown
```

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

### CriticMarkup Deletion Example

Source: http://fletcher.github.io/MultiMarkdown-5/syntax.html

Shows the CriticMarkup syntax for marking text to be deleted from the original document. The text within {-- --} is considered a deletion.

```text
This is {--is --}a test.

```

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

### MultiMarkdown Metadata Example

Source: http://fletcher.github.io/MultiMarkdown-5/metadata.html

Include metadata at the top of your MultiMarkdown document. Keys are case-insensitive and stripped of spaces. Multiline values should be indented.

```markdown
Title:    A Sample MultiMarkdown Document  
Author:   Fletcher T. Penney  
Date:     February 9, 2011  
Comment:  This is a comment intended to demonstrate  
          metadata that spans multiple lines, yet  
          is treated as a single value.  
CSS:      http://example.com/standard.css


```

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

### BibTeX Integration with MultiMarkdown and natbib

Source: http://fletcher.github.io/MultiMarkdown-5/citations.html

These examples demonstrate how MultiMarkdown citation syntax translates to LaTeX commands when using BibTeX and natbib. The syntax distinguishes between `\citep` (parenthetical) and `\citet` (textual) commands.

```text
[#citekey]    =>  \citep{citekey}
[#citekey][]  =>  \citep{citekey}

[foo][#citekey] =>  \citep[foo]{citekey}

[foo\]\[bar][#citekey] =>  \citep[foo][bar]{citekey}


[#citekey;]    =>  \citet{citekey}
[#citekey;][]  =>  \citet{citekey}

[foo][#citekey;] =>  \citet[foo]{citekey}

[foo\]\[bar][#citekey;] =>  \citet[foo][bar]{citekey}
```

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

### MultiMarkdown Citation Without Locator

Source: http://fletcher.github.io/MultiMarkdown-5/citations.html

This example shows how to cite a source without specifying a page number or locator. The citation key must still be provided.

```markdown
This is a statement that should be attributed to its 
source[][#Doe:2006].
```

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

### View Command Line Help

Source: http://fletcher.github.io/MultiMarkdown-5/using_mmd.html

Display available command line options.

```bash
multimarkdown -h
```

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

### Display Help

Source: http://fletcher.github.io/MultiMarkdown-5/using_mmd.html

Shows a summary of how to use MultiMarkdown.

```bash
multimarkdown -h, multimarkdown --help
```

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

### Run Tests

Source: http://fletcher.github.io/MultiMarkdown-5/MMD_Users_Guide.fodt

Verify the build by running all tests. Use 'less' for paginated output or 'grep failed' for a concise view of failures. One test is expected to fail.

```bash
make test-all | less
```

```bash
make test-all | grep failed
```

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

### Help and Version

Source: http://fletcher.github.io/MultiMarkdown-5/using_mmd.html

Options to display help information and the current version of MultiMarkdown.

```APIDOC
## Command Line Options: Help and Version

### Description
These options provide access to help information and the version of the MultiMarkdown installation.

### Method
Command Line

### Endpoint
N/A

### Parameters
#### Command Line Flags
- **-h, --help** - Displays a summary of how to use MultiMarkdown.
- **-v, --version** - Displays the version of MultiMarkdown currently installed.

### Request Example
```bash
multimarkdown --help
multimarkdown --version
```

### Response
#### Success Response
Output will be text describing usage or the version number.

#### Response Example
```text
Usage: multimarkdown [options] [file ...]
MultiMarkdown version 5.x.x
```
```

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

### Use Convenience Scripts

Source: http://fletcher.github.io/MultiMarkdown-5/using_mmd.html

Utilize included scripts as shortcuts for common batch mode operations.

```bash
mmd file.txt
mmd2tex file.txt
mmd2opml file.txt
mmd2odf file.txt
```

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

### Enable Compatibility Mode

Source: http://fletcher.github.io/MultiMarkdown-5/using_mmd.html

Outputs HTML compatible with the original Markdown test suite.

```bash
multimarkdown -c, multimarkdown --compatibility
```

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

### Inline and Display Math with LaTeX Delimiters

Source: http://fletcher.github.io/MultiMarkdown-5/math.html

Demonstrates using LaTeX syntax for inline math with \( \) and display math with \[ \] delimiters. Ensure proper spacing around dollar sign delimiters for LaTeX style math.

```latex
An example of math within a paragraph --- \({e}^{i\pi }+1=0\)
--- easy enough.

And an equation on it's own:

\[ {x}_{1,2}=\frac{-b\pm \sqrt{{b}^{2}-4ac}}{2a} \]

That's it.
```

```latex
An example of math within a paragraph --- ${e}^{i\pi }+1=0$
--- easy enough.

And an equation on it's own:

$$ {x}_{1,2}=\frac{-b\pm \sqrt{{b}^{2}-4ac}}{2a} $$

That's it.
```

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

### Initialize and Update Git Submodules

Source: http://fletcher.github.io/MultiMarkdown-5/MMD_Users_Guide.fodt

After cloning, initialize and update the project's submodules, including the 'greg' software required for compilation.

```bash
git submodule init
git submodule update
```

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

### MultiMarkdown Definition Lists

Source: http://fletcher.github.io/MultiMarkdown-5/MMD_Users_Guide.fodt

Define lists with terms and their corresponding descriptions using this MultiMarkdown syntax. Each definition starts with a colon.

```markdown
Apple
:   Pomaceous fruit of plants of the genus Malus in 
    the family Rosaceae.
:   An american computer company.

Orange
:   The fruit of an evergreen tree of the genus Citrus.
```

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

### Compile MultiMarkdown from Source

Source: http://fletcher.github.io/MultiMarkdown-5/installation.html

Commands to clone, initialize submodules, and compile MultiMarkdown on Mac and Unix-like systems.

```bash
git clone https://github.com/fletcher/MultiMarkdown-5.git
```

```bash
git submodule init
git submodule update
```

```bash
make
```

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

### Configure syntax highlighter metadata

Source: http://fletcher.github.io/MultiMarkdown-5/syntax.html

Include necessary scripts and stylesheets in the HTML header to enable syntax highlighting.

```html
html header:    <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>

```

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

### General Options

Source: http://fletcher.github.io/MultiMarkdown-5/MMD_Users_Guide.fodt

Options for help, version, and output redirection.

```APIDOC
## General Options

### Help
Displays a summary of how to use MultiMarkdown.

### Method
Command Line

### Endpoint
`multimarkdown -h` or `multimarkdown --help`

### Version
Displays the version of MultiMarkdown currently installed.

### Method
Command Line

### Endpoint
`multimarkdown -v` or `multimarkdown --version`

### Output to File
Directs the output to the specified file. By default, the output is directed to `stdout`. The use of `batch` mode obviates the need to use this option, but if you want to specify a different output filename it can be handy.

### Method
Command Line

### Endpoint
`multimarkdown -o=FILE` or `multimarkdown --output=FILE`
```

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

### Compile MultiMarkdown

Source: http://fletcher.github.io/MultiMarkdown-5/MMD_Users_Guide.fodt

Execute the 'make' command to compile the MultiMarkdown source code on Mac and *Nix systems.

```bash
make
```

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

### Standard Footnote Syntax in MultiMarkdown

Source: http://fletcher.github.io/MultiMarkdown-5/footnotes.html

Use this syntax to create standard footnotes. The footnote definition must start on a new line, similar to reference-style links. For multi-paragraph footnotes, indent subsequent paragraphs with a tab.

```markdown
Here is some text containing a footnote.[^somesomefootnote]

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

[somelink]:http://somelink.com
```

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

### Link and Image Attributes Example

Source: http://fletcher.github.io/MultiMarkdown-5/syntax.html

Append attributes like 'width', 'height', 'title', or 'class' to image and link definitions. These attributes are placed after the URL and title, and can span multiple lines. MultiMarkdown does not interpret these attributes but passes them through.

```markdown
This is a formatted ![image][] and a [link][] with attributes.

[image]: http://path.to/image "Image title" width=40px height=400px
[link]:  http://path.to/link.html "Some Link" class=external
         style="border: solid black 1px;"

```

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

### Set Output Format

Source: http://fletcher.github.io/MultiMarkdown-5/using_mmd.html

Specifies the output format, defaulting to html.

```bash
multimarkdown -t html|latex|memoir|beamer|opml|odf|rtf|lyx|lyx-beamer
```

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

### Raw HTML Output (No --process-html)

Source: http://fletcher.github.io/MultiMarkdown-5/raw.html

Demonstrates the output of raw HTML blocks without the '--process-html' command-line option. Only blocks with the 'markdown=1' attribute are processed.

```html
<div>This is *not* MultiMarkdown</div>

<div>This <em>is</em> MultiMarkdown</div>
```

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

### Convert Files via Command Line

Source: http://fletcher.github.io/MultiMarkdown-5/using_mmd.html

Convert a text file to HTML or save the output to a specific file.

```bash
multimarkdown file.txt
```

```bash
multimarkdown file.txt > file.html
```

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

### Force Full Document

Source: http://fletcher.github.io/MultiMarkdown-5/using_mmd.html

Forces the output of a complete document structure.

```bash
multimarkdown -f, multimarkdown --full
```

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

### List Metadata Keys

Source: http://fletcher.github.io/MultiMarkdown-5/using_mmd.html

Lists all available metadata keys contained in a document.

```bash
multimarkdown -m, multimarkdown --metadata-keys
```

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

### Perform Basic Transclusion via CLI

Source: http://fletcher.github.io/MultiMarkdown-5/transclusion.html

Use the mmd output format to perform transclusion without converting to a final document format.

```bash
multimarkdown -t mmd foo.txt

```

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

### Convert Text File to HTML and Save to File

Source: http://fletcher.github.io/MultiMarkdown-5/MMD_Users_Guide.fodt

Convert a text file to HTML and redirect the output to a new file with the '.html' extension.

```bash
multimarkdown file.txt > file.html
```

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

### Process CriticMarkup with MultiMarkdown CLI

Source: http://fletcher.github.io/MultiMarkdown-5/criticmarkup.html

Commands for handling CriticMarkup syntax during document processing.

```bash
multimarkdown foo.txt
```

```bash
multimarkdown -a foo.txt
```

```bash
multimarkdown -r foo.txt
```

```bash
multimarkdown -a -r foo.txt
```

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

### Substitute Metadata Variables

Source: http://fletcher.github.io/MultiMarkdown-5/syntax.html

Use the [%key] syntax to inject metadata values into the document body.

```text
# A Variable in a Heading [%foo] #

A variable in the body [%bar].
```

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

### Create TeXShop Glossary Engine

Source: http://fletcher.github.io/MultiMarkdown-5/syntax.html

Shell script for TeXShop to automate the generation of glossary files during LaTeX compilation.

```bash
#!/bin/ 

set path = ($path /usr/local/teTeX/bin/powerpc-apple-darwin-current 
    /usr/local/bin) # This is actually a continuation of the line above

set basefile = `basename "$1" .tex`

makeindex -s `kpsewhich basic.gst` -o "${basefile}.gls" "${basefile}.glo"
```

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

### Specify Output Formats

Source: http://fletcher.github.io/MultiMarkdown-5/using_mmd.html

Convert input files into specific formats like LaTeX, LyX, OPML, RTF, ODF, or raw MMD.

```bash
multimarkdown -t latex file.txt
```

```bash
multimarkdown -t lyx file.txt
```

```bash
multimarkdown -t opml file.txt
```

```bash
multimarkdown -t rtf file.txt
```

```bash
multimarkdown -t odf file.txt
```

```bash
multimarkdown -t mmd file.txt
```

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

### CriticMarkup Highlighting Syntax

Source: http://fletcher.github.io/MultiMarkdown-5/criticmarkup.html

Syntax for highlighting specific sections of text.

```text
This is a {==test==}.
```

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

### Wildcard File Transclusion

Source: http://fletcher.github.io/MultiMarkdown-5/transclusion.html

Use the .* extension to automatically select a file version matching the output format.

```markdown
Insert a different version of a file here based on export format:
{{foo.*}}

```

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

### Output and Formatting

Source: http://fletcher.github.io/MultiMarkdown-5/using_mmd.html

Options to control the output file and the format of the generated content.

```APIDOC
## Command Line Options: Output and Formatting

### Description
These options control where the output is directed and the format of the generated content.

### Method
Command Line

### Endpoint
N/A

### Parameters
#### Command Line Flags
- **-o, --output=FILE** - Directs the output to the specified file. By default, output goes to `stdout`.
- **-t html|latex|memoir|beamer|opml|odf|rtf|lyx|lyx-beamer** - Specifies the output format. The default is `html`. If `LaTeX Mode` metadata is used, `memoir` or `beamer` will be chosen automatically.
- **-b, --batch** - Automatically redirects output to a file with the same base name as the input file but with the appropriate extension (e.g., `file.txt` becomes `file.html`).

### Request Example
```bash
multimarkdown -o output.html input.md
multimarkdown -t latex input.md
multimarkdown -b input.md
multimarkdown -b -t latex input.md
```

### Response
#### Success Response
Output is generated according to the specified file and format.

#### Response Example
(Output content will vary based on input and format)
```

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

### Raw HTML output in LaTeX

Source: http://fletcher.github.io/MultiMarkdown-5/MMD_Users_Guide.fodt

Demonstrates how block-level HTML is handled when exporting to LaTeX formats.

```latex
This \emph{is} MultiMarkdown

```

```latex
This is \emph{not} MultiMarkdown
This \emph{is} MultiMarkdown

```

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

### Generate Glossary .glo File with makeindex

Source: http://fletcher.github.io/MultiMarkdown-5/glossary.html

Command to generate the .glo file for glossaries using makeindex. Requires the 'basic.gst' file from the memoir class.

```bash
makeindex -s `kpsewhich basic.gst` -o "filename.gls" "filename.glo"

```

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

### Configure LaTeX Metadata for Natbib

Source: http://fletcher.github.io/MultiMarkdown-5/syntax.html

Sets the LaTeX input metadata to use the plain natbib style.

```text
latex input:        mmd-natbib-plain

```

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

### Handle CriticMarkup Changes

Source: http://fletcher.github.io/MultiMarkdown-5/using_mmd.html

Accepts or rejects changes written in CriticMarkup format.

```bash
multimarkdown --accept
multimarkdown --reject
multimarkdown --accept --reject
```

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

### Enable Batch Mode

Source: http://fletcher.github.io/MultiMarkdown-5/using_mmd.html

Automatically redirects output to a file with the same base name as the input file.

```bash
multimarkdown -b, multimarkdown --batch
```

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

### CriticMarkup Substitution Syntax

Source: http://fletcher.github.io/MultiMarkdown-5/criticmarkup.html

Syntax for replacing existing text with new content.

```text
This {~~isn't~>is~~} a test.
```

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

### Clone MultiMarkdown 5 Repository

Source: http://fletcher.github.io/MultiMarkdown-5/MMD_Users_Guide.fodt

Use this command to download the source code for MultiMarkdown 5 from GitHub.

```bash
git clone https://github.com/fletcher/MultiMarkdown-5.git
```

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

### HTML vs. MultiMarkdown Syntax

Source: http://fletcher.github.io/MultiMarkdown-5/MMD_Users_Guide.fodt

Compares verbose HTML syntax for formatting with the simpler MultiMarkdown plain text approach for elements like links, bold, italics, and lists.

```html
<p>In order to create valid 
<a href="http://en.wikipedia.org/wiki/HTML">HTML</a>, you 
need properly coded syntax that can be cumbersome for 
&#8220;non-programmers&#8221; to write. Sometimes, you
just want to easily make certain words <strong>bold
</strong>, and certain words <em>italicized</em> without
having to remember the syntax. Additionally, for example,
creating lists:</p>

<ul>
<li>should be easy</li>
<li>should not involve programming</li>
</ul>

```

```multimarkdown
In order to create valid [HTML], you need properly
coded syntax that can be cumbersome for 
"non-programmers" to write. Sometimes, you just want
to easily make certain words **bold**, and certain 
words *italicized* without having to remember the 
syntax. Additionally, for example, creating lists:

* should be easy
* should not involve programming

[HTML]: http://en.wikipedia.org/wiki/HTML

```

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

### Enable Footnotes

Source: http://fletcher.github.io/MultiMarkdown-5/using_mmd.html

Explicitly enables the use of footnotes and similar markup.

```bash
multimarkdown --notes
```

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

### Raw HTML Output (With --process-html)

Source: http://fletcher.github.io/MultiMarkdown-5/raw.html

Shows the output of raw HTML blocks when the '--process-html' command-line option is used. All block-level HTML tags will have their content processed by MultiMarkdown.

```html
<div>This is <em>not</em> MultiMarkdown</div>

<div>This <em>is</em> MultiMarkdown</div>
```

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

### Convert OPML to Other Formats

Source: http://fletcher.github.io/MultiMarkdown-5/using_mmd.html

Scripts from the MMD-Support package to convert OPML files to HTML, MultiMarkdown, or LaTeX. Requires `xsltproc` and shell script execution capabilities.

```bash
opml2HTML file.opml
```

```bash
opml2mmd file.opml
```

```bash
opml2LaTeX file.opml
```

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

### Convert Text File to HTML

Source: http://fletcher.github.io/MultiMarkdown-5/MMD_Users_Guide.fodt

Convert a plain text file to HTML output using the 'multimarkdown' command.

```bash
multimarkdown file.txt
```

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

### Map MultiMarkdown Syntax to BibTeX Commands

Source: http://fletcher.github.io/MultiMarkdown-5/syntax.html

Shows the mapping between MultiMarkdown citation syntax and LaTeX natbib commands.

```text
[#citekey]    => ~\citep{citekey}
[#citekey][]  => ~\citep{citekey}

[foo][#citekey] => ~\citep[foo]{citekey}

[foo\]\[bar][#citekey] => ~\citep[foo][bar]{citekey}


[#citekey;]    => \citet{citekey}
[#citekey;][]  => \citet{citekey}

[foo][#citekey;] => \citet[foo]{citekey}

[foo\]\[bar][#citekey;] => \citet[foo][bar]{citekey}

```

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

### Compatibility Mode

Source: http://fletcher.github.io/MultiMarkdown-5/MMD_Users_Guide.fodt

Option for ensuring compatibility with original Markdown.

```APIDOC
## Compatibility Mode

### Compatibility
Compatibility mode causes MultiMarkdown to output HTML that is compatible with that output from the original Markdown. This allows it to pass the original Markdown test suite. Syntax features that don’t exist in regular Markdown will still be output using the regular MultiMarkdown output formatting.

### Method
Command Line

### Endpoint
`multimarkdown -c` or `multimarkdown --compatibility`
```

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

### Specify Output File

Source: http://fletcher.github.io/MultiMarkdown-5/using_mmd.html

Directs the output to the specified file instead of stdout.

```bash
multimarkdown -o, multimarkdown --output=FILE
```

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

### CriticMarkup Addition Syntax

Source: http://fletcher.github.io/MultiMarkdown-5/criticmarkup.html

Syntax for marking text to be inserted into the document.

```text
This {++is ++}a test.
```

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

### Configure HTML Header Metadata

Source: http://fletcher.github.io/MultiMarkdown-5/metadata.html

Use this metadata to inject raw HTML into the document header, such as linking external scripts like MathJax.

```text
HTML header:  <script type="text/javascript"
    src="http://example.net/mathjax/MathJax.js">
    </script>

```

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

### Transclude and Output Raw MMD Source

Source: http://fletcher.github.io/MultiMarkdown-5/MMD_Users_Guide.fodt

Perform basic transclusion and output the raw MultiMarkdown source using the '-t mmd' option. This is useful for basic transclusion independent of output formats.

```bash
multimarkdown -t mmd file.txt
```

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

### Configure Base Header Level

Source: http://fletcher.github.io/MultiMarkdown-5/syntax.html

Adjust the document's top-level heading structure using the Base Header Level metadata key.

```text
Base Header Level: 2

# Introduction #
```

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

### Use Dollar Sign Delimiters for Math

Source: http://fletcher.github.io/MultiMarkdown-5/syntax.html

Alternative syntax for math using dollar signs, requiring no space between the delimiter and the math content.

```text
An example of math within a paragraph --- ${e}^{i\pi }+1=0$
--- easy enough.

And an equation on it's own:

$${x}_{1,2}=\frac{-b\pm \sqrt{{b}^{2}-4ac}}{2a}$$

That's it.
```

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

### Convert Text File to OPML

Source: http://fletcher.github.io/MultiMarkdown-5/MMD_Users_Guide.fodt

Generate OPML output from a text file using the '-t opml' option.

```bash
multimarkdown -t opml file.txt
```

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

### Convert Text File to LaTeX

Source: http://fletcher.github.io/MultiMarkdown-5/MMD_Users_Guide.fodt

Generate LaTeX output from a text file using the '-t latex' option.

```bash
multimarkdown -t latex file.txt
```

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

### Configure LaTeX Metadata Directives

Source: http://fletcher.github.io/MultiMarkdown-5/metadata.html

Use these metadata keys to manage LaTeX document structure, including headers, document classes, and footer files.

```text
latex input:        mmd-memoir-header
Title:              MultiMarkdown Example
Base Header Level:  2
latex mode:         memoir
latex input:        mmd-memoir-begin-doc
latex footer:       mmd-memoir-footer

```

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

### Format Superscripts and Subscripts

Source: http://fletcher.github.io/MultiMarkdown-5/syntax.html

Syntax for basic and complex superscripts and subscripts using caret and tilde characters.

```text
This apartment has an area of 100m^2
One must consider the value of x~z
```

```text
y^(a+b)^
x~y,z~
```

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

### Superscripts and Subscripts in MultiMarkdown

Source: http://fletcher.github.io/MultiMarkdown-5/math.html

Use caret (^) for superscripts and tilde (~) for subscripts. For complex exponents or subscripts, delimit them with parentheses.

```markdown
This apartment has an area of 100m^2
One must consider the value of x~z

```

```markdown
y^(a+b)^
x~y,z~
```

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

### Convert Text File to LyX Format

Source: http://fletcher.github.io/MultiMarkdown-5/MMD_Users_Guide.fodt

Generate output suitable for LyX using the '-t lyx' option.

```bash
multimarkdown -t lyx file.txt
```

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

### Toggle Smart Typography

Source: http://fletcher.github.io/MultiMarkdown-5/using_mmd.html

Enables or disables smart typography features.

```bash
multimarkdown --smart
multimarkdown --nosmart
```

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

### Configure LaTeX Document Structure

Source: http://fletcher.github.io/MultiMarkdown-5/MMD_Users_Guide.fodt

Define LaTeX-specific inputs and document settings within the metadata section.

```text
latex input:        mmd-memoir-header
Title:              MultiMarkdown Example
Base Header Level:  2
latex mode:         memoir
latex input:        mmd-memoir-begin-doc
latex footer:       mmd-memoir-footer
```

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

### Define a definition list in MultiMarkdown

Source: http://fletcher.github.io/MultiMarkdown-5/definitionlists.html

Use a colon to prefix definitions for terms. Multiple terms or definitions can be provided for a single entry.

```markdown
Apple
:   Pomaceous fruit of plants of the genus Malus in 
    the family Rosaceae.
:   An american computer company.

Orange
:   The fruit of an evergreen tree of the genus Citrus.

```

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

### Wildcard File Transclusion

Source: http://fletcher.github.io/MultiMarkdown-5/syntax.html

Use a wildcard extension like `{{foo.*}}` to transclude a file that has an extension appropriate for the current output format (e.g., `.tex`, `.fodt`, `.html`).

```markdown
Insert a different version of a file here based on export format:
{{foo.*}}
```

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

### Output Formatting Options

Source: http://fletcher.github.io/MultiMarkdown-5/MMD_Users_Guide.fodt

Options to control the output format and document structure.

```APIDOC
## Output Formatting Options

### Output Format
Specifies the format that MultiMarkdown outputs. The default is html. If you use the `LaTeX Mode` metadata, then MultiMarkdown will automatically choose `memoir` or `beamer` as directed without using these command line options. Using that metadata will also allow the various convenience scripts to choose the correct output format as well.

### Method
Command Line

### Endpoint
`multimarkdown -t html|latex|memoir|beamer|opml|odf|rtf|lyx|lyx-beamer`

### Batch Mode
Automatically redirects the output to a file with the same base name as the input file, but with the appropriate extension based on the output type. For example, `multimarkdown -b file.txt` would output the HTML to `file.html`, and `multimarkdown -b -t latex file.txt` would output to `file.tex`.

### Method
Command Line

### Endpoint
`multimarkdown -b` or `multimarkdown --batch`

### Full Document
Forces a complete document, even if it does not contain enough metadata to otherwise trigger a complete document.

### Method
Command Line

### Endpoint
`multimarkdown -f` or `multimarkdown --full`

### Snippet Output
Forces the output of a “snippet”, meaning that header and footer information is left out. This means that a LaTeX document might not have enough information to be processed, for example.

### Method
Command Line

### Endpoint
`multimarkdown -s` or `multimarkdown --snippet`
```

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

### TeXShop Engine Script for Glossaries

Source: http://fletcher.github.io/MultiMarkdown-5/glossary.html

A shell script to be used as a TeXShop engine for processing documents with glossaries. It sets the path and runs makeindex to generate the .gls file.

```shell
#!/bin/ 

set path = ($path /usr/local/teTeX/bin/powerpc-apple-darwin-current 
    /usr/local/bin) # This is actually a continuation of the line above

set basefile = `basename "$1" .tex`

makeindex -s `kpsewhich basic.gst` -o "${basefile}.gls" "${basefile}.glo"

```