Skip to content

fix(docs): enable mermaid diagrams via pymdownx.superfences custom_fences #20

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jdwit merged 1 commit into from
May 31, 2026
Merged

fix(docs): enable mermaid diagrams via pymdownx.superfences custom_fences #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,15 @@ markdown_extensions:
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.superfences:
# Mermaid.js fence handler. Material for MkDocs bundles
# Mermaid automatically when a `mermaid` custom-fence is
# declared; no separate plugin install is needed. See
# https://squidfunk.github.io/mkdocs-material/reference/diagrams/
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
Expand Down