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
Credits
I am not really a Python programmer, so I have borrowed plugin setup / utils / inspiration from:
Metadata
Release files for mkdocs-plugin-inline-svg 0.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mkdocs-plugin-inline-svg-0.1.0.tar.gz | 3.0 kB | Without provenance | Details for mkdocs-plugin-inline-svg-0.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mkdocs_plugin_inline_svg-0.1.0-py3-none-any.whl | Python 3 | none | any | Details for mkdocs_plugin_inline_svg-0.1.0-py3-none-any.whl |
Total release size: 6.7 kB
Release files / mkdocs-plugin-inline-svg-0.1.0.tar.gz
| Download URL | mkdocs-plugin-inline-svg-0.1.0.tar.gz |
|---|---|
| Size | 3.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
30753efd1769ad68aade76c95382695ef2b9b153ed765167d5137f7bb6c85130
|
|
BLAKE2b-256 checksum How to use checksums |
8133ba546dc1916a305ffe65c4c0e4404b97bc7c2eb3f1ee689cfbe410ead042
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.9.4
|
Release files / mkdocs_plugin_inline_svg-0.1.0-py3-none-any.whl
| Download URL | mkdocs_plugin_inline_svg-0.1.0-py3-none-any.whl |
|---|---|
| Size | 3.7 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a5aab2d98a19b24019f8e650f54fc647c2f31e7d0e36fc5cf2d2161acc0ea49a
|
|
BLAKE2b-256 checksum How to use checksums |
c63d020a6b6248c3d4a37797db068256f0b3f15b01bc481327ba888c50309aa8
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.24.0 requests-toolbelt/0.9.1 tqdm/4.58.0 CPython/3.9.4
|
Security for mkdocs-plugin-inline-svg 0.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.