Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

mkdocs-plugin-inline-svg

Package Overview
Dependencies
Maintainers
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

mkdocs-plugin-inline-svg

A MkDocs plugin that inlines SVG images into the output.

  • 0.1.0
  • PyPI
  • Socket score

Maintainers
1

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:

  • https://github.com/stuebersystems/mkdocs-img2fig-plugin
  • https://github.com/athackst/mkdocs-simple-plugin

Keywords

FAQs


Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc