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-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
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
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-201905.6b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f85dc16da8f8467888d9fff6ec952c4d7767713cf8956327b95537c88497c334 |
|
MD5 | 50b0709b6faf051546acfc0f76b2e741 |
|
BLAKE2b-256 | 3641ecb2260b47255f30f3c7d03c8f60252000657ff6c764a817e74a1052e6ab |
Hashes for markdown_svgbob-201905.6b0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8eefd29162ad8ffdafd288487296a5982d170954487b95f24a63909d6ba651b7 |
|
MD5 | e57a9c5dc2b4f04b29aff070695b2e45 |
|
BLAKE2b-256 | af84b13065da82b9d4066d88858511f8038ed2fc6235a0cfcf28eb74dd3e1849 |