Skip to main content

Convert reStructuredText within Markdown to HTML.

Project description

rst-in-md

!!! warning This project is still in the early stages of development. Please be aware that there may be bugs, and the API may change. Please see the limitations for more information.

rst-in-md is a simple tool to convert reStructuredText within Markdown, built to extend Python Markdown.

You can make full use of more complex reStructuredText elements, and they will be rendered correctly in the final output. Turn something like this:

    ```rst
    +------------------------+------------+----------+----------+
    | Header row, column 1   | Header 2   | Header 3 | Header 4 |
    | (header rows optional) |            |          |          |
    +========================+============+==========+==========+
    | body row 1, column 1   | column 2   | column 3 | column 4 |
    +------------------------+------------+----------+----------+
    | body row 2             | Cells may span columns.          |
    +------------------------+------------+---------------------+
    | body row 3             | Cells may  | - Table cells       |
    +------------------------+ span rows. | - contain           |
    | body row 4             |            | - body elements.    |
    +------------------------+------------+---------------------+
    ```

Into this:

Header row, column 1\n(header rows optional) Header 2 Header 3 Header 4
body row 1, column 1 column 2 column 3 column 4
body row 2 Cells may span columns.
body row 3 Cells may\nspan rows.
  • Table cells
  • contain
  • body elements.
body row 4

To get started, please head to installation guide.

To understand how this tool works, you can read more about the implementation.

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

rst_in_md-0.1.0.tar.gz (50.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rst_in_md-0.1.0-py3-none-any.whl (6.9 kB view details)

Uploaded Python 3

File details

Details for the file rst_in_md-0.1.0.tar.gz.

File metadata

  • Download URL: rst_in_md-0.1.0.tar.gz
  • Upload date:
  • Size: 50.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for rst_in_md-0.1.0.tar.gz
Algorithm Hash digest
SHA256 3e70700ca21f7f166e8fbab011ccf8be4ab5c14f4419e5e7d6a45608df23f3f6
MD5 7cf51be091d4cbecfb1d38cfb86453c1
BLAKE2b-256 0a7f185e43d71d5f29cf55e5c70684d09dccdbb1116a9503f209e850f1c2a673

See more details on using hashes here.

File details

Details for the file rst_in_md-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: rst_in_md-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 6.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for rst_in_md-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a976929a21e473c3b0115406cc332d37031f247741eca3e04874cd8b1ee78abd
MD5 f0e20aa22483feb86634ddb500b1981b
BLAKE2b-256 a93dd50eac269bf4f305be8150041060f5fe3c2401b394ae34ae0e5157fb6fe3

See more details on using hashes here.

Supported by

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