Unofficial Syntax of Markdown


Tag

@(Maintag)[tag2|tag3|tag4]

footnote

Blah…


[TOC]

Code block

@requires_authorization
def somefunc(param1='', param2=0):
    '''A docstring'''
    if param1 > param2: # interesting
        print 'Greater'
    return (param2 - param1 + 1) or None
class SomeClass:
    pass
>>> message = '''interpreter
... prompt'''

Latex

This is a formula: $\Gamma(n) = (n-1)!\quad\forall n\in\mathbb N$.

Another:

$$ x = \dfrac{-b \pm \sqrt{b^2 – 4ac}}{2a} $$

Table

Item Value Qty
Computer 1600 USD 5
Phone 12 USD 12
Pipe 1 USD 234

flowchart

st=>start: Start
e=>end
op=>operation: My Operation
cond=>condition: Yes or No?

st->op->cond
cond(yes)->e
cond(no)->op

sequence chart

Alice->Bob: Hello Bob, how are you?
Note right of Bob: Bob thinks
Bob-->Alice: I am good thanks!

checkbox