News for hackers. Stuff that matters.
Re:GitHub will natively support Mermaid diagrams by bussierem on Thursday January 13, 2022 @06:37PM (#29928578)
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

Re:GitHub will natively support Mermaid diagrams by adverbly on Thursday January 13, 2022 @06:40PM (#29928600)
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.

Re:GitHub will natively support Mermaid diagrams by anduru_h on Thursday January 13, 2022 @05:48PM (#29928091)
As someone who just learned what Mermaid is...this is amazing. Great feature add. Does anyone have good recommendations for learning the syntax / alternatives?
Re:GitHub will natively support Mermaid diagrams by derefnull on Thursday January 13, 2022 @06:50PM (#29928680)
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/

Re:GitHub will natively support Mermaid diagrams by anduru_h on Thursday January 13, 2022 @08:37PM (#29929541)
Awesome! Really appreciate this.
Re:GitHub will natively support Mermaid diagrams by justsomehnguy on Thursday January 13, 2022 @08:40PM (#29929567)
Re:GitHub will natively support Mermaid diagrams by jka on Thursday January 13, 2022 @05:55PM (#29928180)
Nice to see GitHub catching up[1] with GitLab in this area.

[1] - https://web.archive.org/web/20210509204433/https://about.git...

Re:GitHub will natively support Mermaid diagrams by GauntletWizard on Thursday January 13, 2022 @06:53PM (#29928714)
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/

Re:GitHub will natively support Mermaid diagrams by bob1029 on Thursday January 13, 2022 @06:10PM (#29928321)
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.

Re:GitHub will natively support Mermaid diagrams by NmAmDa on Thursday January 13, 2022 @08:42PM (#29929591)
Hopefully LaTeX will be next. Many scientific projects are now on Github and will benefit from that.
Re:GitHub will natively support Mermaid diagrams by cebert on Thursday January 13, 2022 @09:51PM (#29930074)
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.
Re:GitHub will natively support Mermaid diagrams by core-utility on Thursday January 13, 2022 @05:50PM (#29928124)
This is a great addition. Diagrams are a huge hole in documentation-as-code, particularly in something that should be easy to dynamically generate.
Re:GitHub will natively support Mermaid diagrams by mindcrime on Thursday January 13, 2022 @07:10PM (#29928854)
That... is frickin awesome! I am definitely looking forward to starting to use this. Good joerb, GitHub!
Re:GitHub will natively support Mermaid diagrams by bradwood on Friday January 14, 2022 @03:01AM (#29931717)
Gitlab's had this for ages.