Skip to content

Commit

Permalink
Merge pull request #85 from MikhailKravets/2.3.0
Browse files Browse the repository at this point in the history
2.3.0
  • Loading branch information
MikhailKravets authored Oct 25, 2024
2 parents 34f9c02 + 4558b0e commit 9a0e8ea
Show file tree
Hide file tree
Showing 50 changed files with 27,182 additions and 20 deletions.
1 change: 1 addition & 0 deletions docs/docs/assets/themes/material/mkdocs-material.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions docs/docs/getting_started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ As you may have already noticed, when you hover the diagram few buttons appear i
left corner:

- :octicons-copy-16: copies SVG content of the diagram.
- :octicons-download-16: downloads SVG diagram.
- :octicons-plus-16: zooms in the diagram.
- :octicons-home-16: resets the diagram to its default view.
- :octicons-dash-16: zooms out the diagram.
Expand Down
18 changes: 9 additions & 9 deletions docs/docs/getting_started/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,8 +113,10 @@ plugins:

## Theming <theming>

`mkdocs_puml` supports automatic theme switching for light and dark mode. It seamlessly integrates
with [mkdocs-material](https://squidfunk.github.io/mkdocs-material/).
`mkdocs_puml` supports automatic theme switching for light and dark modes. Currently,
the plugin integrates with the mode selectors of default `mkdocs` and
[mkdocs-material](https://squidfunk.github.io/mkdocs-material/) themes. In other
cases, `mkdocs_puml` will choose diagrams based on the browser's color scheme settings.

???+ info "Single-themed mode"

Expand Down Expand Up @@ -145,19 +147,17 @@ plugins:
dark: catppuccin/mocha
```

??? note "This web-site uses catppuccin"
??? note "What theme uses this documentation web-site?"

This documentation web-site uses [Catppuccin](../themes/catppuccin.md) theme
with special `catppuccin/frappe-white` flavor for light mode and
`catppuccin/mocha` for dark mode. Use this configuration to apply the same
settings for your setup
This documentation web-site uses [Material](../themes/material.md) theme
with the following setup

```yaml
plugins:
- plantuml:
theme:
light: catppuccin/frappe-white
dark: catppuccin/mocha
light: material/teal-light
dark: material/deep-orange-dark
```

### Using Custom Theme Repository
Expand Down
3 changes: 2 additions & 1 deletion docs/docs/themes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,11 +10,12 @@ a seamless integration with `mkdocs_puml`.
Currently the hub consists of the following themes.

| **Name** | **Light** | **Dark** | **C4** |
|:----------:|:--------------:|:-----:|:-----:|
|:----------|:--------------:|:-----:|:-----:|
| [Default](default.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| [Catppuccin](catppuccin.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| [Nord](nord.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| [Kanagawa](kanagawa.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: |
| [Material :simple-materialformkdocs:](material.md) | :white_check_mark: | :white_check_mark: | :white_check_mark: |

## How to Use

Expand Down
Loading

0 comments on commit 9a0e8ea

Please sign in to comment.