MatDown Tutorial

Version: 0.12

MatDown is a text-based, readable formatting syntax that extends Markdown and at times looks similar to Python. MatDown turns plain text files into consistent looking documents, resumes, slide decks, etc., allowing you to focus on content rather than formatting.

MatDown boasts many powerful features. The first feature is the ability to run in any web browser. Many of the other features are discussed and demonstrated in this tutorial.

Source: link
Render: link

Note: this tutorial (and MatDown) is a work in progress! Use at your own risk!

Math Stuff

MatDown uses MathJax to render beautiful looking math. Here is some inline math \(x=\frac{1}{2}\), and here is some display math.

\[x = \frac{1}{2}\]

Source code stuff

You can use </code> for source code fences. TODO: <code>prettyprint linenums python should work, but does not.

sample = 'foo bar'

def foo():
    print('test')
    # ^^test^^ **test** _test_

foo()

Enumerations

Below is an ordered list starting with 11.

11. &lt;span style="background-color:yellow">an&lt;/span>
2. ^ordered^
3. ^^list^^
4. ^^^of fun^^^

an
ordered
list
of fun

Below is another ordered list.

a. something b. but not here c. or here

A nested list?

one a. one.one b. one.two
two
- bulleted
- inside
three

Below is an unordered list.

an unordered list
foo
bar

Images

Inlined images with captions automatically float to the right (TODO: fix!!). Inlined images with no captions, such as

, remain inline. Isn't that great?

When an image is in its own paragraph, then the image stands by itself. The image is contained in a figure if it has a caption.

A sequence of captionless images without text should go side-by-side.

A sequence of captioned images without text should float right.

This is a test

Quotes

This is a quote

“
to be or not to be? is that the question?
”