MkDocs plugin for inlining svg-href img tags
Project description
NOTE: this project is still WIP!
mkdocs-inline-svg-plugin
Table of Contents
Installation
pip install mkdocs-inline-svg-plugin
License
mkdocs-inline-svg-plugin is distributed under the terms of the MIT license.
Usage
If you want to inline SVGs, that were put in img tags by the kroki plugin:
mkdocs.yml:
plugins:
- kroki:
FencePrefix: ''
HttpMethod: 'POST'
DownloadImages: true
- inline-svg:
alt_name: Kroki
Configuration
| Config value | What for |
|---|---|
alt_name |
default: *, that does not check the img alt property |
include_assets |
default: False, looks for url(..), downloads the contents to asset_dir and replaces the url |
asset_dir |
default: assets/ |
patch_style |
default: False, this feature is EXPERIMENTAL and not yet finished, needs an additional CSS |
Test
Serve documentation:
hatch run docs:serve
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 mkdocs_inline_svg_plugin-0.1.4.tar.gz
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 11145087c0455754a1462652889bb1cb2015d910ad636eb219cba414f3afb058 |
|
| MD5 | e37ceee440244620a3d958e9723fe808 |
|
| BLAKE2b-256 | ab58465a2889a40555973542dab3e5bc8b749ab8d95b428a239c5f5a56a90b29 |
Close
Hashes for mkdocs_inline_svg_plugin-0.1.4-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | d74106cf8586c15b5ad7a4c8705885802ee5704933d594fd480690e014d53306 |
|
| MD5 | e9cb1619590fd158bb1509311e3b3a62 |
|
| BLAKE2b-256 | 5f705958e0c5095485ab09074f27b1d3eba92d4f33bc99206d7f4cca8fac7321 |
