Registry / devops / mkdocs-plugin-inline-svg

mkdocs-plugin-inline-svg

JSON →
library0.1.0pypypiunverified

A MkDocs plugin that inlines SVG images directly into the HTML output, allowing CSS styling and theming of SVGs. Current version 0.1.0, release cadence low.

devops
pip install mkdocs-plugin-inline-svg
homepage ↗
INSTALL
IMPORT
SIG · MKDOCS-PLUGIN-INLI
M
mkdocs-plugin-inline-svg
devopspythonv0.1.0
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

InlineSvgPlugin
✓ from mkdocs_plugin_inline_svg.src import InlineSvgPlugin
✗ from mkdocs_plugin_inline_svg.plugin import InlineSvgPlugin

Add plugin to mkdocs.yml. Ensure svg files are referenced in Markdown as images (![alt](image.svg)) or directly in HTML.

# mkdocs.yml plugins: - search - inline-svg
Debug
Known issues
gotchaPlugin only processes SVG files referenced via Markdown image syntax or HTML <img> tags. It does not handle SVGs in CSS backgrounds or object elements.
fix
Wrap SVGs in Markdown images or manually inline them.
affects: all
gotchaInlined SVGs may break JavaScript event handlers or external CSS if SVGs contain id or class collisions. The plugin does not prefix ids.
fix
Ensure SVGs have unique ids or use a SVG naming convention.
affects: all
Upgrade
Version history
0.1.0latest on PyPI · released May 12, 2021
Audit
Dependencies
mkdocsrequiredPlugin runs only within MkDocs build process
Agent activity
14 hits · last 30 days
node
14
Resources
homepagehttps://gitlab.com/craig0990/mkdocs-plugin-inline-svg ↗
mkdocs-plugin-inline-svg — pip install mkdocs-plugin-inline-svg · libregistry