Skip to main content

aafigure extension for Python Markdown

Project description

Markdown aafigure

This is an extension for Python Markdown which can render diagrams using aafigure.

Project/Repo:

MIT License Supported Python Versions PyCalVer v201904.0003 PyPI Version PyPI Downloads

Code Quality/CI:

Build Status Type Checked with mypy Code Coverage Code Style: sjfmt

Name role since until
Manuel Barkhau (mbarkhau@gmail.com) author/maintainer 2018-05 -

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

$ cd markdown-aafigure
$ make install
$ make lint mypy test

MkDocs Integration

In your mkdocs.yml add this to markdown_extensions.

markdown_extensions:
  - markdown_aafigure:
      format: svg

Changelog for https://gitlab.com/mbarkhau/markdown_aafigure

v201904.0003

  • Fix #3: escape xml in image data uri
  • Fix: cleanup debug output
  • Change: Move to gitlab.com/mbarkhau/markdown-aafigure
  • Change: Switch to pycalver
  • Change: Project packaging updates

0.2.0 (2018-05-28)

  • Initial release

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

Uploaded Source

Built Distribution

markdown_aafigure-201904.3-py2.py3-none-any.whl (5.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file markdown_aafigure-201904.3.tar.gz.

File metadata

  • Download URL: markdown_aafigure-201904.3.tar.gz
  • Upload date:
  • Size: 7.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for markdown_aafigure-201904.3.tar.gz
Algorithm Hash digest
SHA256 20eba377a6a8a416e3a3f8bae52924c2d8d52e97e920840a00386b4a25e64582
MD5 793cc4cc647af8c86822cf2c1ac81827
BLAKE2b-256 506cdbb4bb0d2e74cf29a3ce3276484414e67b67d8c39fdb9fc42eaa08b2bb4b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: markdown_aafigure-201904.3-py2.py3-none-any.whl
  • Upload date:
  • Size: 5.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3

File hashes

Hashes for markdown_aafigure-201904.3-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 7dcaf42c9a5f7c83b4e75edd9b64d29073b8d688fa6adf5c7589a81fc86adf26
MD5 7ec674165e70d3851d97b25077875a30
BLAKE2b-256 735adecca43a943c1a9369eb10176f9ad35e9ad4f5a33f28b09e00d6896b3953

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