Skip to content
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.

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

feat: support Mermaid diagrams by default #35

Open
jolexxa opened this issue Mar 24, 2024 · 1 comment
Open

feat: support Mermaid diagrams by default #35

jolexxa opened this issue Mar 24, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@jolexxa
Copy link
Member

jolexxa commented Mar 24, 2024

It was brought to my attention recently that GitHub can render Mermaid diagrams inside markdown beautifully.

Mermaid's state diagrams are almost identical to the ones used by PlantUML, except it doesn't support nested state descriptions, which is what the logic blocks generator is currently making.

So instead of this:

state "State1" as state_one {
    state_one : text
}

We need to flatten it out, like this:

state "State1" as state_one

state_one : text
@jolexxa jolexxa added the enhancement New feature or request label Mar 24, 2024
@jolexxa
Copy link
Member Author

jolexxa commented May 15, 2024

I did modify the generator to produce flatter state descriptions. Unfortunately, this is still blocked by the lack of support for composite states with descriptions: mermaid-js/mermaid/issues/1493

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant