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

  • Add: Support of format: png extension configuration (requires Pillow)
  • Fix: Use base64 encoding for image uri

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

Uploaded Source

Built Distribution

markdown_aafigure-201904.4-py2.py3-none-any.whl (5.9 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: markdown_aafigure-201904.4.tar.gz
  • Upload date:
  • Size: 7.3 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.4.tar.gz
Algorithm Hash digest
SHA256 1b111a23f6ddb3768ba5c9e46d2a1f83d1fc4fa8029976c4e1a5cafcdeb4671f
MD5 2a67354277dee5c3cf97771a7fe40244
BLAKE2b-256 e0d6ef0c7a59e2216cf0cff22b6e21f8ac0469926484a9be0f79516e7c51c1e0

See more details on using hashes here.

File details

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

File metadata

  • Download URL: markdown_aafigure-201904.4-py2.py3-none-any.whl
  • Upload date:
  • Size: 5.9 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.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f5c3a330f84efe01b9fbb62793cf817416c0132853acf04a607ee109bd06d898
MD5 679812bc4b375e13beeb082c25875d53
BLAKE2b-256 fc62edc8ee32c060ef894b55df284bb68a825e2381a555a63dc67c2f60f276a9

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