Metadata-Version: 2.1
Name: markdown-mermaid-to-images
Version: 0.1.1
Summary: Exports mermaid diagrams in Markdown documents as images.
Home-page: https://gitlab.com/hmajid2301/markdown-mermaid-to-images.git
Author: hmajid2301
Author-email: hmajid2301@gmail.com
License: Apache License
Description: .. image:: https://gitlab.com/hmajid2301/markdown-mermaid-to-images/badges/master/pipeline.svg
           :target: https://gitlab.com/hmajid2301/markdown-mermaid-to-images
           :alt: Pipeline Status
        
        .. image:: https://gitlab.com/hmajid2301/markdown-mermaid-to-images/badges/master/coverage.svg
           :target: https://gitlab.com/hmajid2301/markdown-mermaid-to-images
           :alt: Coverage
        
        .. image:: https://img.shields.io/pypi/l/markdown-mermaid-to-images.svg
           :target: https://pypi.org/project/markdown-mermaid-to-images/
           :alt: PyPI Project License
        
        .. image:: https://img.shields.io/pypi/v/markdown-mermaid-to-images.svg
           :target: https://pypi.org/project/markdown-mermaid-to-images/
           :alt: PyPI Project Version
        
        markdown-mermaid-to-images
        ==========================
        
        A CLI tool for publishing markdown articles to dev.to. The tool will also update articles if they already exist
        on dev.to. It matches articles based on title in the frontmatter. 
        
        Usage
        -----
        .. code-block:: bash
        
          pip install markdown-mermaid-to-images
          markdown_mermaid_to_images --help
        
        Usage: markdown_mermaid_to_images [OPTIONS]
        
          Exports mermaid diagrams in Markdown documents as images.
        
        Options:
          -m, --file PATH                 Path to markdown file, where the mermaid
                                          code blocks will be converted to images.
          -f, --folder PATH               Path to folder where we will convert all
                                          markdown mermaid code blocks to images.
          -i, --ignore PATH               Path to folder to ignore, markdown files in
                                          this folder will not be converted.
          -o, --output PATH               Path to folder where to save the new
                                          markdown files.  [required]
          -l, --log-level                 [DEBUG|INFO|ERROR]
                                          Path to folder where to save the new
                                          markdown files.
          --help                          Show this message and exit.
        
        .. code-block:: bash
        
            $ markdown_mermaid_to_images -f tests/data -o tests/data/output/ -i tests/data/another_folder
        
        Example Markdown File
        *********************
        
        Where an example markdown file may look something like this. The meramid code blocks
        must be surrounded by three ` and have the class ``mermaid``.
        
        .. code-block:: 
        
          ## Introduction
        
          Example Document
        
          ## Heading
        
          ```mermaid
          graph LR;
            A --> B;
          ```
        
          > INFO: Info
        
          ```mermaid
          graph LR;
            A --> B
            B --> C
            subgraph 1;
            subgraph 2;
            C --> D;
            end
            end;
          ```
        
        This will then get converted into a file that looks like
        
        .. code-block:: 
        
          Introduction
          ------------
        
          Example Document
        
          Heading
          -------
        
          ![Image](a18fcc0f6bf14950b5115b22752471cc.png)
        
          > INFO: Info
        
          ![Image](7d2490309c1c4bf48069dd7399944ff4.png)
        
        GitLab CI
        *********
        
        You can use also use this in your CI/CD with the provided Docker image. Below is an example ``.gitlab-ci.yml`` file,
        you may wish to use or include. The advantage of this is you can publish your aritcles using CI/CD.
        
        .. code-block:: yaml
        
          stages:
            - pre-publish
        
          convert-mermaid:markdown:
            image: registry.gitlab.com/hmajid2301/markdown-mermaid-to-images
            stage: pre-publish
            script:
              - markdown_mermaid_to_images --folder tests/data --ignore tests/data/another_folder --output tests/data/output
        
        Setup Development Environment
        ==============================
        
        .. code-block:: bash
        
          git clone git@gitlab.com:hmajid2301/markdown-mermaid-to-images.git
          cd markdown-mermaid-to-images
          pip install tox
          make install-venv
          source .venv/bin/activate
          make install-dev
        
        Changelog
        =========
        
        You can find the `changelog here <https://gitlab.com/hmajid2301/markdown-mermaid-to-images/blob/master/CHANGELOG.md>`_.
        
Keywords: markdown,mermaid,exporter
Platform: UNKNOWN
Classifier: Programming Language :: Python
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: ~=3.6
Description-Content-Type: text/x-rst
