A MkDocs plugin that inlines SVG images into the output with utf-8 encoding.
Project description
mkdocs-plugin-inline-svg-utf8
Extend the plugin from craig0990 to read UTF-8 encoded files
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-utf8
Enable the plugin in your mkdocs.yml:
plugins:
- search
- inline-svg-utf8
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
Credits
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_svg_utf8-0.1.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | e90d4b9829382a7461634c4bfb99ddf9fc711efbd5d06e8c40bd363f213799e6 |
|
MD5 | f6741eff7d293580cdea18a78474cc28 |
|
BLAKE2b-256 | eae3a431054183415938583f2508232a660a64b92242be09add1e7582eb0cf31 |
Hashes for mkdocs_plugin_inline_svg_utf8-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e3c1070d50a96b2ecfe52f4310a481e8349eea0b7eea5f1036ae783c1e8b4963 |
|
MD5 | b81731998f4cdfaca9c2f0d3df757ab8 |
|
BLAKE2b-256 | 12b473ea7822f5f430ee370bfa9e4be9d979bde60555503646270ef1996053a2 |