svgbob extension for Python Markdown
Project description
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:
Name | role | since | until |
---|---|---|---|
Manuel Barkhau (mbarkhau@gmail.com) | author/maintainer | 2019-04 | - |
Install
$ pip install markdown-svgbob
This package includes the following binaries:
svgbob_0.4.1_x86_64-Darwin
svgbob_0.4.1_x86_64-Linux
svgbob_0.4.1_x86_64-Windows
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://gitlab.com/mbarkhau/markdown-svgbob
$ cd markdown-svgbob
$ make install
$ 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://gitlab.com/mbarkhau/markdown-svgbob
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
andfg_color
options
v201905.0006-beta
- Fix: better error reporting
- Fix: cleanup temp dir
v201904.0004-beta
- 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-svgbob-202103.1016.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c25080a0075e0a2c32f60dc03774888b85fd61cad7ffd70685e5daa77e4fe103 |
|
MD5 | 0fd610ab308dcb7a2fe3972e2c4d657f |
|
BLAKE2b-256 | 7495bad6efb5c404817eeab1d0736bafe7ce2a61502f2b014e712c38973cb027 |
Hashes for markdown_svgbob-202103.1016-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 808ac1ad52b6c6a3d4dc53502fab6da4010b82297c1d0db84f45b3b046ae3166 |
|
MD5 | 8cfc3d1112fb1d3b6890ba405bc1196d |
|
BLAKE2b-256 | c535fda4d40d68b400bcfcf42f96369427e1e9deee709f7ca8a8922eed1bee87 |