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

$ rm dist/*; python setup.py sdist bdist_wheel upload

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.2.0.tar.gz (3.8 kB view details)

Uploaded Source

Built Distribution

markdown_aafigure-0.2.0-py2.py3-none-any.whl (4.3 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file markdown-aafigure-0.2.0.tar.gz.

File metadata

File hashes

Hashes for markdown-aafigure-0.2.0.tar.gz
Algorithm Hash digest
SHA256 8300927db72a1df7e8b28978829c91e439245ce59d91b3a757ac5de6e3c43314
MD5 b42ee41809f11048b2813b9430488682
BLAKE2b-256 4f928f23b598b5991f2474be266b5a868b3b3c414c07f442ebb3ce35d9a352aa

See more details on using hashes here.

File details

Details for the file markdown_aafigure-0.2.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for markdown_aafigure-0.2.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 fdeaf7131d3ff9d5998ef2cc1384260e049d54b0bea0a9222511ffb9638d02b6
MD5 0646b5b59de9322016dabc4a15b017e9
BLAKE2b-256 63027720ce1d6fac5fd7172bb848daff98c15d758d32efdca5c4d5eec4880c6a

See more details on using hashes here.

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