Metadata-Version: 2.1
Name: md_mermaid_ort
Version: 0.1.2
Summary: Fork of original md_mermaid by Olivier Ruelle, including some fixes with PR awaiting on the upstream
Home-page: https://github.com/orobardet/md_mermaid
Author: Olivier Robardet
Author-email: olivier.robardet@gmail.com
License: UNKNOWN
Description: # md_mermaid
        
        mermaid extension for Python-Markdown to add support for mermaid graph inside markdown file
        
        ## Installation
        
        For `pip` installation (only python version >=3.x) :
        
        ~~~shell
        pip install markdown
        pip install md-mermaid
        ~~~
        
        ## Usage
        
        In your python script :
        
        ~~~python
        import markdown
        
        text = """
        # Title
        
        Some text.
        
        ​~~~mermaid
        graph TB
        A --> B
        B --> C
        ​~~~
        
        Some other text.
        
        ​~~~mermaid
        graph TB
        D --> E
        E --> F
        ​~~~
        """
        
        html = markdown.markdown(text, extensions=['md_mermaid'])
        
        print(html)
        ~~~
        
        Output will result in :
        
        ~~~html
        <h1>Title</h1>
        <p>Some text.</p>
        <div class="mermaid">
        graph TB
        A --> B
        B --> C
        </div>
        
        <p>Some other text.</p>
        <div class="mermaid">
        graph TB
        D --> E
        E --> F
        </div>
        
        <script>mermaid.initialize({startOnLoad:true});</script>
        
        ~~~
        
        The `<script>...</script>` line appears only once even if there are several graphs in the file.
        
        > Note that the extension name have a '_' not a '-'.
        
        > Attention : don't forget to include in your output html project the two following mermaid files :
        >
        > * mermaid.css (optional, can be customised)
        > * mermaid.min.js (can be download here [here](https://unpkg.com/mermaid@8.1.0/dist/)) 
        
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Topic :: Text Processing :: Filters
Classifier: Topic :: Text Processing :: Markup :: HTML
Description-Content-Type: text/markdown
