Skip to content

Commit

Permalink
Additional notes in README.
Browse files Browse the repository at this point in the history
  • Loading branch information
Laurent Franceschetti committed Jul 28, 2023
1 parent f4586b1 commit 2be83d0
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,17 +139,17 @@ plugins:
The plugin will insert the correct call to the javascript library
inside the final HTML page.

### Use of the Material theme
### Additional settings for the Material theme

!!! Note
The [Material theme](https://squidfunk.github.io/mkdocs-material/),
developed by [squidfunk](https:/squidfunk)
is not mandatory, but recommended.

**Mermaid diagrams will automatically adapt their colors to the theme
and palette.**
> The [Material theme](https://squidfunk.github.io/mkdocs-material/),
> developed by [squidfunk](https:/squidfunk)
> is not mandatory, but recommended.

Here are the recommended settings in the configuration file:
**Mermaid diagrams will automatically adapt their colors to the theme
and palette.**

Here are the _additional_ recommended settings in the configuration file:

```yaml
markdown_extensions:
Expand All @@ -162,6 +162,9 @@ markdown_extensions:
```

> Do not use these additional settings for other themes,
> as diagrams will probably **not** be displayed correctly.


## For more information
See the [documentation on ReadTheDocs](https://mkdocs-mermaid2.readthedocs.io).

0 comments on commit 2be83d0

Please sign in to comment.