- 106comments
- 30comments
- 412comments
- 18comments
- 176comments
- 82comments
- 45comments
- 23comments
- 7comments
- 532comments
- 9comments
- 104comments
- 125comments
- 183comments
- —discuss
- 25comments
- 299comments
- 361comments
- 17comments
- 23comments
- 88comments
- 22comments
- 47comments
- 8comments
- 44comments
- 4comments
- 7comments
- 122comments
- 278comments
- 118comments
As someone who just learned what Mermaid is...this is amazing. Great feature add. Does anyone have good recommendations for learning the syntax / alternatives?
I also just learned about Mermaid. Looks great. PlantUML is what I’ve been using to achieve similar documentation goals with text
https://hn.algolia.com/?q=plantuml previous discussions
https://plantuml.com/
Awesome! Really appreciate this.
dot/Graphviz
https://en.wikipedia.org/wiki/DOT_(graph_description_languag...
https://en.wikipedia.org/wiki/Graphviz
Can be used in PowerShell:
https://github.com/KevinMarquette/PSGraph
This is a great addition. Diagrams are a huge hole in documentation-as-code, particularly in something that should be easy to dynamically generate.
Nice to see GitHub catching up[1] with GitLab in this area.
[1] - https://web.archive.org/web/20210509204433/https://about.git...
There are so many times I would have used this. At least 20% of my issues could have benefited from an in-line diagram tool.
Being able to quickly draw out complex sequence/state diagrams would make my otherwise dense bricks of narrative descriptions much more palatable for many teammates.
I'm very excited about this! I’m looking forward to combining this with ARCHITECTURE.md[0] files to make some kick-ass documentation for our company’s devs for our repo(s).
[0]: https://matklad.github.io/2021/02/06/ARCHITECTURE.md.html
Amazing! Mermaid is great. Happy to see it get more widespread adoption!
This will make it much easier to keep documentation up to date. Much easier to change 1 line than to generate new images and take an updated screenshot or export, especially if you dont have the source file for whatever editor generated the original image.
Mermaid would not be my first choice of diagramming software (that would be plain old Graphviz with PlantUML for more full featured graphs), but I'm glad to see some diagramming support on GitHub natively. There's already quite a few tools that let you embed via hotlink or generated link your graph.
[1] https://graphviz.org/ [2] https://plantuml.com/
That... is frickin awesome! I am definitely looking forward to starting to use this. Good joerb, GitHub!
Hopefully LaTeX will be next. Many scientific projects are now on Github and will benefit from that.
This is really exciting. My team is trying to move off Confluence in favor of storing more documentation and design artifacts in GitHub. This will help make that more possible.
Gitlab's had this for ages.