Markup Styles¶

Code¶

Here is an example on code highlight:

@app.route('/', methods=['GET')
def hello(name='world'):
    return 'Hello {}'.format(name)

class API(object):
    """API docstring style"""

    def __init__(self, request):
        # comment
        self.request = request

Using code-block with other options.

function test() {
  console.log('hi');
}

1
2
3

fn main() {
    println!("Hello World!");
}

Quote¶

Here is an example on block quote:

Beautiful is better than ugly.

Explicit is better than implicit.

Simple is better than complex.

Complex is better than complicated.

Flat is better than nested.

Sparse is better than dense.

Readability counts.

Special cases aren’t special enough to break the rules.

Although practicality beats purity.

Errors should never pass silently.

Unless explicitly silenced.

In the face of ambiguity, refuse the temptation to guess.

There should be one– and preferably only one –obvious way to do it.

Although that way may not be obvious at first unless you’re Dutch.

Now is better than never.

Although never is often better than right now.

If the implementation is hard to explain, it’s a bad idea.

If the implementation is easy to explain, it may be a good idea.

Namespaces are one honking great idea – let’s do more of those!

List¶

• Make a list, and its items
  1. Ordered item: foo
     1. A third level item
  2. Ordered item: bar
• The second item has no items
• The third item has unordered items
  • A foo is a foo
  • A bar is a bar

Options Lists¶

Footnotes¶

Plain text Typical result Footnote references, like [5]. Note that footnotes may get rearranged, e.g., to the bottom of the “page”.

Autonumbered footnotes are possible, like using [1] and [2].

They may be assigned ‘autonumber labels’ - for instance, [4] and [3].

Citations¶

Citation references, like [CIT2002]. Note that citations may get rearranged, e.g., to the bottom of the “page”.