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
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
v201904.0001-alpha
- 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
Close
Hashes for markdown-svgbob-201904.3b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | a155f2c358992ae0919b2d3b63252dea7374964141f7a191c840fb3ec80d46bc |
|
MD5 | 5a1d3ab311d3b62c1c749b4ecc3bc75b |
|
BLAKE2b-256 | 50069b060aecd5f04f3724d058d9b76689201771d50898b0e6e873744d318364 |
Close
Hashes for markdown_svgbob-201904.3b0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e801db7e21ff061eccfa30573080c0023ebebf1c20636ef0c285afb9753ed593 |
|
MD5 | 15e8e825cf47239ac0925e35c61c293a |
|
BLAKE2b-256 | f9c7fbc1f2bf7af5c5b21f7f459027ced7d819e552cfb603bba62173503a4af3 |