Skip to content

Instantly share code, notes, and snippets.

@goodmind
Forked from javiertejero/README.rst
Last active March 17, 2019 10:41
Show Gist options
  • Save goodmind/44662b4a5d0e232de4b4b41a3082cb82 to your computer and use it in GitHub Desktop.
Save goodmind/44662b4a5d0e232de4b4b41a3082cb82 to your computer and use it in GitHub Desktop.

A paragraph containing only two colons indicates that the following indented or quoted text is a literal block.

Whitespace, newlines, blank lines, and
all kinds of markup (like *this* or
\this) is preserved by literal blocks.

The paragraph containing only '::'
will be omitted from the result.

The :: may be tacked onto the very end of any paragraph. The :: will be omitted if it is preceded by whitespace. The :: will be converted to a single colon if preceded by text, like this:

It's very convenient to use this form.

Literal blocks end when text returns to the preceding paragraph's indentation. This means that something like this is possible:

    We start here
  and continue here
and end here.

Per-line quoting can also be used on unindented literal blocks:

> Useful for quotes from email and
> for Haskell literate programming.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment