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.2b0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0439b2098c7d1144885a1937cf373c1214cf3c648055969d62a7d659e6df0429 |
|
MD5 | e994ab2311ba86416f7decf035baf722 |
|
BLAKE2b-256 | 98040043cc0ef61c92cacf5c13559da88688e969709e7f2d08d50a97ee2d5f05 |
Close
Hashes for markdown_svgbob-201904.2b0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b97810ee8d6ed7547c9a1fccd3029e75ef054cfeed4a0f199d605d72ffd736b9 |
|
MD5 | 3a8dbcce46cdaed51d6c0ac5df3daeb3 |
|
BLAKE2b-256 | c1ed82b0471e4f18975000cc1e178e8e2b44d927829190e49f14c280a04f0c3d |