quuxplusone 18 hours ago

Some nits:

The "Example" buttons don't jump out at me; I found them but it took a while. Also consider labeling them with their point, e.g. "Example 3: Color"

If you change the input text to something well-formed, the graph seems to update immediately. But if you change it to something ill-formed, the graph doesn't update immediately — and then if you click "Generate" manually, it blanks the input box. Either this is a bug, or the "Generate" button doesn't do what I think it does (i.e. generate output). Again, adding a noun to the verb might help. Or just adding some usage information somewhere on the page.

For those like me who've never heard of "Mermaid," apparently it's like GraphViz's dot language but different. https://github.com/mermaid-js/mermaid I tried the flowchart example from Mermaid's own README, but it didn't come out right: looks like the shape characters [] and {} aren't handled.

  • lordswork 13 hours ago

    Counter-nit: I found the examples within a few seconds.

    • brink 8 hours ago

      Counter-counter-nit: I did not.

  • matt3210 14 hours ago

    Same, I had no idea there were examples until I read this.

  • AlexanderGrooff 18 hours ago

    Thanks for the feedback! I agree that the web UI can be improved (quite) a bit, most of my efforts went into the actual generation of the diagrams. I'll have a look at prettifying it.

nunobrito 16 hours ago

Hey, where are the mermaids?!?

But now seriously.. the diagrams are working really well for simple examples, thank you so much for sharing this tool. I have bookmarked your page, my documentation is based on text files and often have to build these kind of diagrams too.

The example buttons took me a while to be found, but are good for syntax explanation. Thank you for making this available.

jonahx 16 hours ago

Nice work, I love ascii diagrams. Especially useful when you want a visual explanation that can be embedded directly in source code.

Small nit on layout: 90 degree joints should use "+" in the connecting lines, as they do in the boxes.

  • AlexanderGrooff 18 minutes ago

    Thanks for the recommendation. I've added the "+" corners in v0.5.1.

girvo 9 hours ago

Hah we rely on Mermaid a _heap_ at work for building internal dependency graphs from `yarn info` JSON data and a super lazy depth-first graph haha. Super useful, nice to see another renderer!

ts-directed-graph outputs Mermaid :)

This tool seems way more useful for hand-made ones, definitely bookmarking

  • danpalmer 8 hours ago

    Out of interest have you managed to get Mermaid graphs rendering outside of a browser?

    I was trying to do this a while back so I could do server side rendering of graphs, but it seemed to depend strongly on the presence of a DOM. Couldn’t quite get it working with JS-DOM either.

    • pjungwir 8 minutes ago

      I've used [mmdc](https://github.com/mermaid-js/mermaid-cli) to generate mermaid images from a Makefile. It looks like it is implemented with puppeteer, so perhaps it doesn't quite fit your request. But if you just want something you can use at the cli, it is great.

flykespice 6 hours ago

Wow! this will come pretty in hand when building plaintext documentation using diagrams.

piedpiper99 17 hours ago

I supposed it's good for basic usage. I just tried a more complex graph and it didn't render well.

nlake906 14 hours ago

love it, will definitely be using it for sketching documentation in comments for SQL sprocs, etc.

One request: support for self-reference, i.e. "A --> A", "A --> A & B"

  • AlexanderGrooff 14 hours ago

    Thanks, that's a good suggestion. I'm also noticing that's not working as intended.

ewalk153 18 hours ago

This would be great to build into project readme workflows.

airstrike 15 hours ago

         ┌──────────────┐
         │ It's 2024... │
         └───────┬──────┘
                 │
    ╔════════════╧═════════════╗
    ║    I wish box drawing    ║
    ║ characters were the norm ║
    ╚══════════════════════════╝