Metadata-Version: 2.3
Name: rst-in-md
Version: 0.1.0
Summary: Convert reStructuredText within Markdown to HTML.
Project-URL: Documentation, https://sebpretzer.github.io/rst-in-md/
Project-URL: Source, https://github.com/sebpretzer/rst-in-md
Author-email: Seb Pretzer <24555985+sebpretzer@users.noreply.github.com>
License: MIT License
        
        Copyright (c) 2024 Seb Pretzer
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
License-File: LICENSE
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.11
Requires-Dist: beautifulsoup4>=4.12.0
Requires-Dist: docutils>=0.21.0
Requires-Dist: markdown>=3.5.0
Provides-Extra: ci
Requires-Dist: pre-commit>=3.0.0; extra == 'ci'
Provides-Extra: docs
Requires-Dist: mkdocs-material>=9.0.0; extra == 'docs'
Requires-Dist: mkdocs>=1.5.0; extra == 'docs'
Provides-Extra: publishing
Requires-Dist: hatch>=1.12.0; extra == 'publishing'
Provides-Extra: test
Requires-Dist: pytest>=7.0.0; extra == 'test'
Description-Content-Type: text/markdown

# 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](./explanations/limitations.md) for more information.

`rst-in-md` is a simple tool to convert [reStructuredText](https://docutils.sourceforge.io/rst.html) within [Markdown](https://daringfireball.net/projects/markdown/), built to extend [Python Markdown](https://python-markdown.github.io/).


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

```markdown
    ```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:

<div class="md-typeset__scrollwrap">
   <div class="md-typeset__table">
      <table>
         <colgroup>
            <col width="43%">
            <col width="21%">
            <col width="18%">
            <col width="18%">
         </colgroup>
         <thead valign="bottom">
            <tr>
               <th>Header row, column 1\n(header rows optional)</th>
               <th>Header 2</th>
               <th>Header 3</th>
               <th>Header 4</th>
            </tr>
         </thead>
         <tbody valign="top">
            <tr>
               <td>body row 1, column 1</td>
               <td>column 2</td>
               <td>column 3</td>
               <td>column 4</td>
            </tr>
            <tr>
               <td>body row 2</td>
               <td colspan="3">Cells may span columns.</td>
            </tr>
            <tr>
               <td>body row 3</td>
               <td rowspan="2">Cells may\nspan rows.</td>
               <td colspan="2" rowspan="2">
                  <ul>
                     <li>Table cells
                     </li>
                     <li>
                        contain
                     </li>
                     <li>
                        body elements.
                     </li>
                  </ul>
               </td>
            </tr>
            <tr>
               <td>
                  body row 4
               </td>
            </tr>
         </tbody>
      </table>
   </div>
</div>


To get started, please head to [installation](./guides/installation.md) guide.

To understand how this tool works, you can read more about the [implementation](./explanations/implementation.md).
