statelyai/feedback

Generate Mermaid Diagram on cli

Opened this issue · 4 comments

Details

There is a facility to generate the mermaid output for a state machine using the online editor. However it would be useful to be able to do this on the cli, so that it could be embedded for example into a readme or other documentation source.

This would also be useful to add as a check into a CI pipeline to make sure the docs were up to date.

Category

XState

Hmmm, I've programmed a "Mermaid to XState" script; making docs as we speak. There seems to be interest in "XState to Mermaid"?

Hmmm, I've programmed a "Mermaid to XState" script; making docs as we speak. There seems to be interest in "XState to Mermaid"?

Would love to see this!

+1

Details

There is a facility to generate the mermaid output for a state machine using the online editor. However it would be useful to be able to do this on the cli, so that it could be embedded for example into a readme or other documentation source.

@deemp & @markios Here it is; sorry I forgot to let you know!
edit: https://github.com/tomByrer/mermax