https://github.com/grufbert/mkdocs-plugin-inline-svg-utf8

mkdocs plugin inline svg image with UTF-8 encoding
https://github.com/grufbert/mkdocs-plugin-inline-svg-utf8

mkdocs svg utf8

Last synced: 4 months ago
JSON representation

mkdocs plugin inline svg image with UTF-8 encoding

• Host: GitHub
• URL: https://github.com/grufbert/mkdocs-plugin-inline-svg-utf8
• Owner: Grufbert
• License: mit
• Created: 2024-09-06T13:28:42.000Z (5 months ago)
• Default Branch: main
• Last Pushed: 2024-09-06T21:21:58.000Z (5 months ago)
• Last Synced: 2024-09-25T21:03:47.853Z (4 months ago)
• Topics: mkdocs, svg, utf8
• Language: Python
• Homepage: https://pypi.org/project/mkdocs-plugin-inline-svg-utf8/
• Size: 13.7 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# 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

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