Skip to content

oniboni/mkdocs-inline-svg-plugin

Repository files navigation

NOTE: this project is still WIP!

mkdocs-inline-svg-plugin

PyPI - Version PyPI - Python Version


Table of Contents

Installation

pip install mkdocs-inline-svg-plugin

License

mkdocs-inline-svg-plugin is distributed under the terms of the MIT license.

Usage

If you want to inline SVGs, that were put in img tags by the kroki plugin:

mkdocs.yml:

plugins:
  - kroki:
      FencePrefix: ''
      HttpMethod: 'POST'
      DownloadImages: true
  - inline-svg:
      alt_name: Kroki

Configuration

Config value What for
alt_name default: *, that does not check the img alt property
include_assets default: False, looks for url(..), downloads the contents to asset_dir and replaces the url
asset_dir default: assets/
patch_style default: False, this feature is EXPERIMENTAL and not yet finished, needs an additional CSS

Test

Serve documentation:

hatch run docs:serve

About

No description, website, or topics provided.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages