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.
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-Darwinsvgbob_0.4.1_x86_64-Linuxsvgbob_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
Valid options for tag_type are inline_svg (the default), img_utf8_svg and img_base64_svg.
Changelog for https://gitlab.com/mbarkhau/markdown-svgbob
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
typingpackage. 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
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
File details
Details for the file markdown-svgbob-202001.11b0.tar.gz.
File metadata
- Download URL: markdown-svgbob-202001.11b0.tar.gz
- Upload date:
- Size: 2.9 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9f269230db92ad70f481a7787d219a113563745d5f9b576664a409895548c000 |
|
| MD5 | ba89577cda5cbcce74d5f200646f4bf6 |
|
| BLAKE2b-256 | 770e36db0aa09eaf7b73ee9e17a3d59839b71604702d9f087cb90639a21e3a98 |
File details
Details for the file markdown_svgbob-202001.11b0-py2.py3-none-any.whl.
File metadata
- Download URL: markdown_svgbob-202001.11b0-py2.py3-none-any.whl
- Upload date:
- Size: 3.5 MB
- 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/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.7.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5ba53ad8e0d123d7ee41d2ab5b96789d4d94825840255cb35cb311874abb30eb |
|
| MD5 | e63c4e609b7666a3641b0ebc6d556ddd |
|
| BLAKE2b-256 | 0697b20e779308aefd95d47ba57bc0c58272c022089a995e57b92c52ca312d41 |
