Skip to main content

aafigure extension for Python Markdown

Project description

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

This is the aafigure extension for Python Markdown

Install

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

Use

In your markdown text you can define the block:

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

Parameters can be set for individual figures. Availabale parameters

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

Testing

$ 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

$ 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.

markdown_extensions:
  - markdown_aafigure:
      format: svg

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

markdown-aafigure-0.1.8.tar.gz (3.7 kB view hashes)

Uploaded Source

Built Distribution

markdown_aafigure-0.1.8-py2.py3-none-any.whl (4.2 kB view hashes)

Uploaded Python 2 Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page