NOTE: this project is still WIP!

mkdocs-inline-svg-plugin

Table of Contents

Installation

pip install mkdocs-inline-svg-plugin

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

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

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

Serve documentation:

hatch run docs:serve