mkdocs-izsam-mermaid-to-images 1.1

MkDocs plugin to convert Mermaid code blocks to images.

MkDocs IZSAM Mermaid to images

This plugin processes each page's Markdown content, finds Mermaid code blocks, converts them to images using mermaid.cli, and replaces the code blocks with image references. The image format can be specified in the mkdocs.yml configuration file.

Installation

Install dependencies:

npm install -g @mermaid-js/mermaid-cli

Install the package with pip:

pip install mkdocs-izsam-mermaid-to-images

Enable the plugin in the mkdocs.yml file:

plugins:
  - search
  - mkdocs-izsam-mermaid-to-images:
      output_dir: 'mermaid_images'
      image_format: 'svg'  # or 'png'

See how to use MkDocs Plugins

Change log

[1.0.1] - 2024-09-17

Setup bug fix and README changes

Bug fix for setup entry_points section; fix for error in configuration instructions.

[1.0] - 2024-09-17

First release