search

phetsims / alpenglow

Experimental rasterization engine, by PhET Interactive Simulations
MIT License
10 stars 0 forks source link

Mermaid diagram for raster-clip isn't working on GitHub markdown #3

Closed jonathanolson closed 1 year ago

jonathanolson commented 1 year ago

If you browse https://github.com/phetsims/alpenglow/blob/main/doc/raster-clip.md, it just shows a not-very-helpful error.

@marlitas, any thoughts on what I'm doing wrong here? It is working in the WebStorm/Intellij preview, AND the Mermaid live editor

marlitas commented 1 year ago

Hmmm I remember having an issue once with this with the onboarding doc. I don't remember the fix exactly but I'll investigate.

marlitas commented 1 year ago

Okay this is fixed. The github mermaid renderer is waaay more finicky than mermaid's live editor and apparently even IntelliJ's here's an issue I found that talks about error message improvement: https://github.com/mermaid-js/mermaid/issues/4388 ... although it might also be that github isn't fully up to date on the latest mermaid version so that syntax isn't something their API understands?

It was a very basic syntax change of moving a class definition on a node to a different spot. In order to debug I went line by line until the preview broke again. Not the most efficient but worked.

I also decreased the font size to work a bit better with the github preview window, but feel free to revert if that's not ideal.

jonathanolson commented 1 year ago

Thank you, this is perfect!