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

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

Uploaded Source

Built Distribution

markdown_aafigure-201904.2-py2.py3-none-any.whl (5.7 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

  • Download URL: markdown_aafigure-201904.2.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.2.tar.gz
Algorithm Hash digest
SHA256 f3c7236703fae0fbfee7bd426f301edacb21a1d7e2dbdd533f06452fd86cfbd4
MD5 c53d8fcd5b2d87d3152e9134823c08e5
BLAKE2b-256 0f7d7427a4d70690f5424a9a141af1b01169859a3f4f1cf5703913ca407b675b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: markdown_aafigure-201904.2-py2.py3-none-any.whl
  • Upload date:
  • Size: 5.7 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.2-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 828b0c0d584619db82b3534560797ff041cd7d10b6db5a36ea579fbe207717fd
MD5 8719c3c4e308754b4531024a7a18e65e
BLAKE2b-256 b8ecf73c491baa2cff2faaa1d682ad6d858deba3949a88a8c12a19402a9937b6

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