Skip to main content

a markup language similar to markdown

Project description

stonemark -- a strict markup language similar to MarkDown

A much less forgiving markdown implementation, which is to say: if I can't tell what the document layout is supposed to be in text format, I don't want the converter guessing for me.

The basic indentation is four spaces, although lists start at either zero or two space indentation. Indented code blocks are not allowed after a list.

Currently supported syntax:

    Element                 StoneMark Syntax

                            ==========
    Heading                 H1 Heading    H2 Heading   H3 Heading
                            ==========    ==========   ----------

    Bold                    **bold text**

    Italic                  *italicized text*

    Bold & Italic           ***bold, italicized text***

    Ordered List            1. First item
                            2. Second item
                            3. Third item

    Unordered List          - First item
                            - Second item
                            - Third item

    Code                    `code`

    Horizontal Rule         --- or ***

    Link         (in-line)  [title](https://www.example.com)

                (separate)  [title][id]
                            ...
                            [id]: <https://www.example.com>

    Image                   ![alt text](image.jpg)


    Fenced Code Block       ``` or ~~~
                            {
                              "firstName": "John",
                              "lastName": "Smith",
                              "age": 25
                            }
                            ``` or ~~~

    Footnote                Here's a sentence with a footnote. [^1]

                            [^1]: This is the footnote.

    Strikethrough           ~~The world is flat.~~

    Underline               __Pay attention.__

    Highlight               I need to highlight these ==very important words==.

    Subscript               H~2~O
    Superscript             X^2^

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

stonemark-0.3.6.tar.gz (31.2 kB view hashes)

Uploaded Source

Built Distributions

stonemark-0.3.6-py3-none-any.whl (31.6 kB view hashes)

Uploaded Python 3

stonemark-0.3.6-py2-none-any.whl (31.6 kB view hashes)

Uploaded Python 2

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page