markdown-svgbob

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

You can try it out using the Svgbob Editor or the AsciiGrid Editor.

Project/Repo:

Code Quality/CI:

Install

$ pip install markdown-svgbob

This package includes the following binaries:

• svgbob_0.5.5_x86_64-Darwin
• svgbob_0.5.5_x86_64-Linux
• svgbob_0.5.5_x86_64-Windows.exe

If you are on another platform, or want to use a more recent version of svgbob_cli, you will need to install rust and then svgbob via cargo.

$ curl https://sh.rustup.rs -sSf | sh   # see https://rustup.rs/
$ cargo install svgbob_cli

This extension will always use the installed version of svgbob if it is available.

Usage

In your markdown text you can define the block:

```bob
     .---.
    /-o-/--
 .-/ / /->
( *  \/
 '-.  \
    \ /
     '
```

The info string bob is chosen to match spongedown.

Development/Testing

$ git clone https://github.com/mbarkhau/markdown-svgbob
$ cd markdown-svgbob
$ make conda
$ make lint mypy test

MkDocs Integration

In your mkdocs.yml add this to markdown_extensions.

markdown_extensions:
  - markdown_svgbob:
      tag_type: inline_svg
      bg_color: white
      fg_color: black
      min_char_width: 80

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

The option min_char_width allows you to create diagrams of a uniform scale.

Changelog for https://github.com/mbarkhau/markdown-svgbob

v202406.1023

• fix requirements specifier

v202112.1022

• Upgrade svgbob binaries to 0.5.5

v202109.1020

• Upgrade to svgbob 0.6.2 for Linux
• Packaging with lib3to6==202108.1048

I can't get newer binaries for windows or macos, contributions to svgbob would be welcome. https://github.com/ivanceras/svgbob/issues/35

v202107.1018

• Fix: False positive warning due to 'toc' extension.

v202104.1016

• Fix: Close file descriptiors of Popen
• Add support for blocks with extra backticks

v202103.1015

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

v202006.0015

• Fix: bg_color not updated in some cases

v202001.0013-beta

• Fix #2: Ignore trailing whitespace after closing fence.

v202001.0012-beta

• Add: min_char_width option. Allows diagrams in a document to have a uniform scale.

v202001.0011-beta

• Fix: Bad image substitution when markdown has multiple diagrams

v202001.0009-beta

• Fix: Bad parsing of fences

v201907.0008-beta

• Fix: use PEP 508 environment marker to not always install the typing package. Fixes gitlab#1

v201905.0007-beta

• Add: bg_color and fg_color options

v201905.0006-beta

• Fix: better error reporting
• Fix: cleanup temp dir

v201904.0004-beta

• Initial release