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.5.5_x86_64-Darwin
svgbob_0.5.5_x86_64-Linux
svgbob_0.5.5_x86_64-Windows.exe
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://github.com/mbarkhau/markdown-svgbob
$ cd markdown-svgbob
$ make conda
$ 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://github.com/mbarkhau/markdown-svgbob
v202406.1023
- fix requirements specifier
v202112.1022
- Upgrade svgbob binaries to 0.5.5
v202109.1020
- Upgrade to svgbob 0.6.2 for Linux
- Packaging with lib3to6==202108.1048
I can't get newer binaries for windows or macos, contributions to svgbob would be welcome. https://github.com/ivanceras/svgbob/issues/35
v202107.1018
- Fix: False positive warning due to 'toc' extension.
v202104.1016
- Fix: Close file descriptiors of Popen
- Add support for blocks with extra backticks
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
File details
Details for the file markdown_svgbob-202406.1023.tar.gz
.
File metadata
- Download URL: markdown_svgbob-202406.1023.tar.gz
- Upload date:
- Size: 2.6 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.9.19
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2796456f333bf704ec86d72a4f8b57b5d5b1d19fc1b10e5f011ee739dab98679 |
|
MD5 | e03192153d828db9b98b4d0b2cd8d876 |
|
BLAKE2b-256 | 3135d52df2b584fd0be9592b7f410a71589451dd43d5d28d5461b8a9edceae6e |
File details
Details for the file markdown_svgbob-202406.1023-py2.py3-none-any.whl
.
File metadata
- Download URL: markdown_svgbob-202406.1023-py2.py3-none-any.whl
- Upload date:
- Size: 2.6 MB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/5.1.0 CPython/3.9.19
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 522db794608a55f27c09ff077078f6222d9fe18ac78e5d0fb9f80c464b7a2029 |
|
MD5 | fd8fb68d270507950a41965784bc1fc6 |
|
BLAKE2b-256 | 9f90124fdb27219ac19a621d9de72b0da158480d9af1974f70b184a9a4050bd4 |