Mkdocs plugin to render inline svg files
Project description
mkdocs-plugin-inline-svg
Reads SVG images referenced from Markdown and replaces them with the SVG file content
Since the SVG is included as part of the plain-text input to MkDocs, this means the default MkDocs search supports searching SVG text, and hyperlinks are also fully functional.
Usage
Install the package with pip:
pip install mkdocs-plugin-inline-svg
Enable the plugin in your mkdocs.yml:
plugins:
- search
- inline-svg
Note: If you have no plugins entry in your config file yet, you'll likely also want to add the search plugin. MkDocs enables it by default if there is no plugins entry set, but now you have to enable it explicitly.
More information about plugins in the MkDocs documentation
Options
You can filter with the extension to select files to be inline. Useful to mix regular and inlined svgs.:
plugins:
- search
- inline-svg:
extension: ".inline.svg"
Build
pip install build
python -m build
Credits
Forked from Craig Roberts / mkdocs-plugin-inline-svg
I am not really a Python programmer, so I have borrowed plugin setup / utils / inspiration from:
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 mkdocs_plugin_inline_ext_svg-0.1.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 711202927735827214a8f57044b3e095b25be8296180b4e323f9e6c12dcea8cc |
|
MD5 | 5193605afee8183fca5c3a16c0f5ec35 |
|
BLAKE2b-256 | 24f9bb7c0f1c37c8978f411a9ac5ab2d073290d1142547a497589427fad01fa6 |
Hashes for mkdocs_plugin_inline_ext_svg-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 22edba52650ee617681d921074a2f3999dc8ef9e1cecd6aeb4e7a68cdc7e191d |
|
MD5 | 90b064d50044aa90f13d52fbb142496c |
|
BLAKE2b-256 | 0a76b02d675142ae806afd56beb07131637135b2ab70ec537bb4f677d4237315 |