Skip to main content

aafigure extension for Python Markdown

Project description

Markdown aafigure

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

Project/Repo:

MIT License Supported Python Versions PyCalVer v202001.0009 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 -

INFO: You may want to consider using the markdown-svgbob extension instead of this one. svgbob has an online editor and supports a wider range of shapes and diagrams. Its main disadvantage is that it "only" has builtin support for x86_64 on Windows, Linux and Mac, in contrast to aafigure which is pure python and supported everywhere.

Install

$ pip install markdown-aafigure
$ pip install Pillow    # only if you want to render as png

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
```

Development/Testing

$ git clone https://gitlab.com/mbarkhau/markdown_aafigure
$ cd markdown_aafigure
$ make install
$ make lint mypy test

MkDocs Integration

In your mkdocs.yml add this to markdown_extensions.

markdown_extensions:
  - markdown_aafigure:
      tag_type: inline_svg

Valid options for tag_type are inline_svg (the default), img_utf8_svg, img_base64_svg, img_base64_png.

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

v202001.0009

  • Fix: Ignore trailing whitespace after closing fence.

v202001.0008

  • Fix: Bad image substitution when markdown has multiple diagrams

v201907.0006

  • Fix: don't require typing package for py<35

v201904.0005

  • Add: Support for inline svg
  • Add: tag_type option for better control of embedding
  • Depricated: format parameter

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

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for markdown-aafigure, version 202001.9
Filename, size File type Python version Upload date Hashes
Filename, size markdown_aafigure-202001.9-py2.py3-none-any.whl (7.8 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size markdown_aafigure-202001.9.tar.gz (11.1 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page