aafigure extension for Python Markdown
Project description
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 (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
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for markdown_aafigure-202001.9.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d6a5ff9360db8a4a66f5c00c3dbfc6b554396954f5c7e22cc82c8d45f487e320 |
|
MD5 | 6c6a49c3e4ade2d9d03bec8b835fb771 |
|
BLAKE2b-256 | 819eae6bbcdf405674384b9513caf59509beed964a517b2b6462991fff731f52 |
Hashes for markdown_aafigure-202001.9-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 45672e545265d16f47be5a336c13f69dd9daa61112001c9279fda6304b67d7c8 |
|
MD5 | de4d24145f187a22876cd8a7091c561e |
|
BLAKE2b-256 | f73137b1f74d0c7a98af724f05b6fe5bb5130865af8addbad1587dbdd9005dae |