mkdocs-mermaid2-plugin icon indicating copy to clipboard operation
mkdocs-mermaid2-plugin copied to clipboard

With superfences: <<join>> and <<choice>> not rendered

Open johnny opened this issue 10 months ago • 3 comments

When using the superfences configuration as per the docs, <<join>> and <<choice>> are not rendered correctly:

  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:mermaid2.fence_mermaid_custom

This results choice and join nodes to be rendered as standard text nodes in the stateDiagram-v2

Example diagram:

stateDiagram-v2
    state split <<choice>>
    [*] --> split
    split --> one: Option 1
    split --> two: Option 2

With superfences Image Without superfences Image

johnny avatar Feb 20 '25 13:02 johnny

Thank you for your contribution! This is very appreciated.

github-actions[bot] avatar Feb 20 '25 13:02 github-actions[bot]

Thanks: define "correctly", in terms of what you expected?

Also, specify what theme you are using?

fralau avatar Feb 20 '25 17:02 fralau

Correct would be the diamond. Incorrect is the name "split"

I'm using mkdocs material

johnny avatar Feb 20 '25 18:02 johnny