https://gitlab.com/craig0990/mkdocs-plugin-inline-svg

Reads SVG images referenced from Markdown and replaces them with the SVG file content
https://gitlab.com/craig0990/mkdocs-plugin-inline-svg

Last synced: about 1 month ago
JSON representation

Reads SVG images referenced from Markdown and replaces them with the SVG file content

• Host: gitlab.com
• URL: https://gitlab.com/craig0990/mkdocs-plugin-inline-svg
• Owner: craig0990
• License: mit
• Created: 2021-05-12T10:17:59.612Z (over 3 years ago)
• Default Branch: master
• Last Synced: 2024-09-30T22:14:38.679Z (about 2 months ago)
• Stars: 0
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# 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