Metadata-Version: 1.1
Name: markdown-aafigure
Version: 0.1.3
Summary: aafigure extension for Python Markdown
Home-page: https://github.com/mbarkhau/markdown-aafigure
Author: Manuel Barkhau
Author-email: mbarkhau@gmail.com
License: MIT
Description: Markdown aafigure

        ==================

        

        .. image:: https://travis-ci.org/mbarkhau/markdown-aafigure.svg?branch=master

            :target: https://travis-ci.org/mbarkhau/markdown-aafigure

        

        

        This is the `aafigure <https://aafigure.readthedocs.io/>`_

        extension for `Python Markdown <https://python-markdown.github.io/>`_

        

        Install

        -------

        

        .. code-block::

        

          $ pip install markdown-aafigure

          $ pip install Pillow    # only for any format other than svg

        

        

        Use

        ---

        

        In your markdown text you can define the block:

        

        .. code-block::

        

          ```aafigure

                +-----+   ^

                |     |   |

            --->+     +---o--->

                |     |   |

                +-----+   V

          ```

        

        Parameters can be set for individual figures.

        `Availabale parameters  <http://aafigure.readthedocs.io/en/latest/sphinxext.html#options>`_

        

        .. code-block::

        

          ```aafigure {"foreground": "#ff0000"}

                +-----+   ^

                |     |   |

            --->+     +---o--->

                |     |   |

                +-----+   V

          ```

        

        

        Testing

        -------

        

        

        .. code-block::

        

          $ pip install flake8 pytest pytest-coverage

          $ flake8 src/

          $ python setup.py --quiet install && pytest tests/

        

        

        MkDocs Integration

        ------------------

        

        In your mkdocs.yml add this to markdown_extensions.

        

        .. code-block::

        

          markdown_extensions:

            - markdown_aafigure:

                format: svg

        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Beta
Classifier: Environment :: Console
Classifier: Environment :: Other Environment
Classifier: Intended Audience :: Developers
Classifier: License :: Other/Proprietary License
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
