Markdown

Markdown is a lightweight and easy-to-use syntax for styling all forms of writing on the GitHub platform.

Markdown is a way to style text on the web. You control the display of the document; formatting words as bold or italic, adding images, and creating lists are just a few of the things we can do with Markdown. Mostly, Markdown is just regular text with a few non-alphabetic characters thrown in, like # or *.

Most important formatter for our ESI standard is that code blocks are nicely formatted with a kind of code syntax recognition. This can be done by surrounding the code block with \`\``.

Like:

    ```lua
        local lib = require('library')
        lib:process()
    ```

will be shown as:

    local lib = require('library')
    lib:process()

More guidance can be read here.