Metadata-Version: 2.1
Name: markdown-aafigure
Version: 0.1.8
Summary: aafigure extension for Python Markdown
Home-page: https://github.com/mbarkhau/markdown-aafigure
Author: Manuel Barkhau
Author-email: mbarkhau@gmail.com
License: MIT
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Environment :: Other Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: Unix
Classifier: Operating System :: POSIX
Classifier: Operating System :: Microsoft :: Windows
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
Description-Content-Type: text/x-rst
Requires-Dist: Markdown
Requires-Dist: aafigure

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:: bash

    $ 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:: text

    ```aafigure
          +-----+   ^
          |     |   |
      --->+     +---o--->
          |     |   |
          +-----+   V
    ```

Parameters can be set for individual figures.
`Availabale parameters  <https://aafigure.readthedocs.io/en/latest/sphinxext.html#options>`_

.. code-block:: text

    ```aafigure {"foreground": "#ff0000"}
          +-----+   ^
          |     |   |
      --->+     +---o--->
          |     |   |
          +-----+   V
    ```


Testing
-------


.. code-block:: bash

    $ pip install flake8 pytest pytest-coverage
    $ flake8 src/
    $ python setup.py --long-description | rst2html5 --strict > README.html
    $ python setup.py --quiet install --force; pytest -v --cov=markdown_aafigure --cov-report term-missing tests/


Publish
-------

.. code-block:: bash

    $ pip install rst2html5
    $ pip install twine
    $ rm dist/*
    $ python setup.py sdist bdist_wheel
    $ twine upload dist/*


MkDocs Integration
------------------

In your mkdocs.yml add this to markdown_extensions.

.. code-block:: yaml

    markdown_extensions:
      - markdown_aafigure:
          format: svg


