example

I’ll begin with a demonstration of typesetting mathematics with Markdown, and demonstrate basic text formatting at the same time. In the expressions below, the number of filters is N_f, the flux associated with the ith filter is F_i, and the weight, w_i, is defined as

where σ_F, i is the uncertainty in the flux associated with the ith filter. Assume that all sums range from i = 1 to i = N_f and use the summation convention on repeated indices. Note that we strike things out like ~~this~~, italicize things like this or like this, and we can make things bold like this or like this.

Unfortunately, –> and => do not turn into arrows automatically, but you can make arrows like this → and ⇒. You can also implement a Pandoc filter to add features that are not built-in. So, it would be possible to make –> turn into → and introduce new features, such as Graphviz graph rendering. For examples of such filters, check out this list (or keep reading this document).

Table Creation

There are many ways of creating tables. This is an example of the pipe table creation syntax…

Line Blocks

Label	Description
`meanflx`	$${\langle F\rangle=\frac{1}{N_f}\sum_i F_i}$$
`wmeanflx`	$${\langle F\rangle_w=\frac{F_i w_i}{\sum_i w_i}}$$
`rmsflx`	$${\sqrt{\langle F^2\rangle_w} = \sqrt{\frac{F_i^2 w_i}{\sum_i}}}$$

Demonstration of simple table syntax.
Right	Left	Center
12	12	12
123	123	123
1	1	1

Normally, adjacent lines are combined together, so a set of short formatted lines, such as an address or verse, becomes jumbled. To overcome this, place | at the beginning of each line, followed by a space. This preserves the formatting:

I am the very model of a modern Major-General,
I’ve information vegetable, animal, and mineral,
I know the kings of England, and I quote the fights historical
From Marathon to Waterloo, in order categorical
I’m very well acquainted, too, with matters mathematical,
I understand equations, both the simple and quadratical,
About binomial theorem I’m teeming with a lot o’ news,
With many cheerful facts about the square of the hypotenuse.

I’m very good at integral and differential calculus;
I know the scientific names of beings animalculous:
In short, in matters vegetable, animal, and mineral,
I am the very model of a modern Major-General.

Inserting an Image

Block Quotes

Enumerated lists

Example Lists

Syntax Highlighting

A Python syntax highlighting example:

You can include blocks of pre-formatted text, like this. If the text is source code, you can tell Pandoc to perform syntax highlighting. This is graphviz.py:

#!/usr/bin/env python

"""
Pandoc filter to process code blocks with class "graph" into
graphviz-generated images.
Requires pygraphviz, pandocfilters
"""

import os
import sys

import pygraphviz

from pandocfilters import toJSONFilter, Para, Image, get_filename4code
from pandocfilters import get_caption, get_extension, get_value

def document_name():
    if "PANDOC_INPUT_FILE" in os.environ:
        return os.environ["PANDOC_INPUT_FILE"]
    else:
        return "graph"

def graphviz(key, value, format, _):
    if key == 'CodeBlock':
        [[ident, classes, keyvals], code] = value
        if "graph" in classes:
            caption, typef, keyvals = get_caption(keyvals)
            prog, keyvals = get_value(keyvals, u"prog", u"dot")
            filetype = get_extension(format, "svg", html="svg", latex="pdf")
            dest = get_filename4code(document_name(), code, filetype)

            if not os.path.isfile(dest):
                g = pygraphviz.AGraph(string=code)
                g.layout()
                g.draw(dest, prog=prog)
                sys.stderr.write('Created image ' + dest + '\n')

            image = Image([ident, classes, keyvals], 
                          caption, 
                          [dest, typef])

            return Para([image])

if __name__ == "__main__":

    toJSONFilter(graphviz)

A C++ syntax highlighting example:

Here’s another example using a different programming language (and a different method of specifying the pre-formatted text block).

#include <iostream>

int main()
{
    // comment
    std::cout << "Hello, World!\n";
    return 0;
}

An example of the power of filters (graphviz.py)

This is an example of a feature that was added using a Pandoc filter (refer to the Python code above). Plain Pandoc does not automatically render Graphviz syntax to inline images, but the short Python program above adds this feature.

Note how this is rendered with prog=neato, instead of prog=dot, which is the default. Other options are twopi, circo, fdp, and nop:

Compiling this with Pandoc

# BTW, this is a Bash syntax highlighting example.

$ pandoc example.md -s --smart --mathjax \
         --css nrstyle.css \
         --highlight-style pygments \
         --columns=200 \
         --filter graphviz.py \
         -o example.html

Major Section Heading

Math