Skip to content

Commit

Permalink
docs: Render mermaid graphs (#568)
Browse files Browse the repository at this point in the history
Add the plugin as a dependency as per [installation guide](https://github.com/fralau/mkdocs-mermaid2-plugin#installation).
`poetry add mkdocs-mermaid2-plugin --group docs`

Add to the `mkdocs.yml` via [plugins
syntax](https://www.mkdocs.org/dev-guide/plugins/)

This on it's own is sufficient to get the diagrams to render.

Resolves: #567
  • Loading branch information
lewismiddleton authored Apr 9, 2024
1 parent 7e869d8 commit 7f87a23
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,11 @@ markdown_extensions:
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- tables
- attr_list
- md_in_html
Expand Down

0 comments on commit 7f87a23

Please sign in to comment.