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 details)

Uploaded Source

Built Distribution

markdown_aafigure-0.1.8-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.8.tar.gz.

File metadata

File hashes

Hashes for markdown-aafigure-0.1.8.tar.gz
Algorithm Hash digest
SHA256 b5f5b5d123d53480c2d4ed9d0d936e57a88872fbf3db5e789b45d4611f160c1d
MD5 e2669ed934191dffad30386e3a1c685d
BLAKE2b-256 ff6676d81ed4925ea77bbc65bab4142ef88d975984a84f958e3b8db9e0ce06b7

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for markdown_aafigure-0.1.8-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 adaa9b44bb6c89953841f4ae8ac4d998ff85fe006bcf5b1a0f743b59e1de1abb
MD5 549ab9fe587650ddefe754f482d10905
BLAKE2b-256 3fc1ae23d24f4ca6e80c3eb8a25a38e45cf7ead31ccf9f2cac7fe29a281b2f5d

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