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

$ 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.9.tar.gz (3.6 kB view details)

Uploaded Source

Built Distribution

markdown_aafigure-0.1.9-py2.py3-none-any.whl (4.2 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

File hashes

Hashes for markdown-aafigure-0.1.9.tar.gz
Algorithm Hash digest
SHA256 88e10aef4853542fa20217053f9cf88679989eb094d53891b2d9259733f3c4fc
MD5 810440e9ef365e922bdd321641140382
BLAKE2b-256 a88f9eba77e77aa11410841472e3b88b6164d53d86606cb19a1543450538bd2b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for markdown_aafigure-0.1.9-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 c664761a22ee60ea2341dd9365326c0e80c6de54991df37846ec052ecd4b3116
MD5 a587f423e6f9f7695e4ca14ff90a68cd
BLAKE2b-256 9175148a81f38851a645476904b2bec9893b7153074fe287d8693cbb73b58dd7

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