markdown-aafigure 202405.1012

aafigure extension for Python Markdown

Markdown aafigure

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

Project/Repo:

Code Quality/CI:

Name	role	since	until
Manuel Barkhau ([e-mail])	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

v202104.1011

• Add support for blocks with extra backticks

v202103.1010

• Fix related to #14: Since Markdown>=3.3 support for Markdown in HTML was broken.

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