Material Theme

🚀 What's New?

Material Theme Support

Since now, you can use material theme that implements color schemes of mkdocs-material. In order to use material theme set the desired flavors for light and dark mode as follows

plantuml:
  theme:
    light: material/indigo-light
    dark: material/indigo-dark

With the material theme, you can style your PlantUML diagrams to closely resemble mermaidjs diagrams.

Read more in a dedicated Material Theme Card.

Default mkdocs Theme Support

Since this release, mkdocs_puml automatically adjusts diagram colors when using the default mkdocs theme mode switch.

Download Button

We've added a button to the control panel to download the diagram.

Meet the Docs

🚀 What's New?

Documentation web-site

Now the documentation of the project is available at mikhailkravets.github.io/mkdocs_puml. Check it out!

New Configs

There were added two new config parameters

request_timeout

Specify how much time httpx must wait for a response from PlantUML server

plugins:
  - plantuml:
      request_timeout: 300

join_project_name

This is a cache parameter. Set it to false if you want to commit your diagrams to the Git. Read more in the documentation.

🔧 Improvements

• Migrate from Flit + Pipenv to Poetry.
• Update the project logo.

Themes, Bug Fixes, and Improvements

🚀 What's New?

Nord Theme

We've applied Nord color palette for PlantUML. Nord theme has two flavors

• day for light mode
• night for dark mode

For more information, visit Nord card.

Kanagawa Theme

We've, also, applied Kanagawa.nvim color palette for PlantUML.
Kanagawa theme has two flavors as well

• fuji for light mode
• wave for dark mode

For more information visit Kanagawa card.

🔧 Improvements

• Fix #64
• Fix #62

Themes, Cache, and Beyond

This release delivers several long-awaited features. Looking back at what’s been accomplished, it’s surprising that it took nearly two years to finally bring it all together. However, it's here and we invite everyone to try the new version 🔥 .

🚀 What's New?

Themes

We've added full support for automatic light / dark theming of diagrams that works not only with plantuml.com server but with all PlantUML servers. You can choose a theme for each mode by adding the following lines to the mkdocs.yml

theme:
  light: default/light
  dark: default/dark

You can combine different themes together

theme:
  light: default/light
  dark: catppuccin/mocha

By default mkdocs_puml searches for themes in its github repository but you can setup your own server or repository for your custom themes.

Themes Repository

mkdocs_puml now includes its own repository of themes. For version 2.0.0, we have prepared two themes

• default — a default PlantUML theme for diagrams + enhanced dark mode for C4;
• catppuccin — an implementation of famous catppuccin theme for PlantUML.

🎨 Read more about mkdocs_puml themes

Storage and Cache

You don't need to re-render diagrams that are already fine. You only need to render those that have been changed.
Now, mkdocs_puml persists the diagrams in the file and requests PlantUML server only with the ones that were
modified by user. This significantly reduces the documentation build time.

You can manage the storage behavior by modifying cache parameter

cache:
  backend: local
  local:
    path: "~/.cache/mkdocs_puml"

Alternatively, you can disable caching entirely

cache:
  backend: disabled

This will keep the diagrams in RAM only.

Asynchronous HTTP requests

In this release we have removed ThreadPoolExecutor. Now, we request a server asynchronously, allowing all requests to run concurrently. So, roughly speaking, a user is constrained only by a throughput of PlantUML server.

Rich terminal output

A small but pleasant feature: we’ve added a nice terminal output that displays the current status of mkdocs_puml.
The output is enabled by default but can be disabled simply by

verbose: false

Interactive diagrams

We added interaction to diagrams.

Now, you can move and zoom diagrams. Also, you can copy svg code to clipboard.

Hotfix Dark Mode

Improvements

@MaciejKucia hotfixed #48 in #49. Thank you 🔥

Dark Mode

This release primarily focuses on dark-themed diagrams. The plugin now generates two versions of diagrams (light and dark) by default.
To restore the previous behavior, you should set auto_dark config to false:

plugins:
    - plantuml:
        puml_url: https://www.plantuml.com/plantuml/
        auto_dark: false

New

• @OnceUponALoop added a support for dark diagrams in #44. Thank you 🔥

Improvements

• @dev-artisan fixed #43. Thank you 🔥

Micro release 1.3.1

Improvements

• Fix compatibility issue with mkdocs ~= 1.5 by @Yannis4444 in #40
• Update dependencies versions in Pipfile.lock

Skip SSL verification

New

• Add verify_ssl parameter to optionally skip SSL certificates verification.

Micro release 1.2.4

Improvements

• Update dependencies versions to the latest state

Resolve compatibility issues with mkdocs >= 1.5

Improved

Make this plugin compatible with mkdocs ~= 1.5.0