FWIW Gitlab already renders Mermaid natively, and it's totally client-side (done in the browser) which means there's no rendering server to install, no image to host differently is each branch, etc.
Cf https://docs.gitlab.com/ee/user/markdown.html#mermaid
Show HN: Programmatically Generate Diagrams for GitHub Readmes
11–19 of 19 posts
Re: Show HN: Programmatically Generate Diagrams for GitHub Readmes
#12Question: how does the local embed link translate into an asset uploaded to github user content?
https://camo.githubusercontent.com/461a806ab46b5db76dcb02048...
Re: Show HN: Programmatically Generate Diagrams for GitHub Readmes
#13FWIW Gitlab already renders Mermaid natively, and it's totally client-side (done in the browser) which means there's no rendering server to install, no image to host differently is each branch, etc. Cf https://docs.gitlab.com/ee/user/markdown.html#mermaid
Wow, thanks for this! I had no idea, this is extremely useful.
Re: Show HN: Programmatically Generate Diagrams for GitHub Readmes
#14FWIW Gitlab already renders Mermaid natively, and it's totally client-side (done in the browser) which means there's no rendering server to install, no image to host differently is each branch, etc. Cf https://docs.gitlab.com/ee/user/markdown.html#mermaid
Wow, thanks for this! I had no idea, this is extremely useful.
It is. We write all our technical documentation (as well as specs, etc. even meeting minutes) using markdown with embedded mermaid diagrams, and during CI have it transformed (via pandoc and ad-hoc scripting) into PDF with corporate company headers.
Looks gorgeous and has all the benefits of version controlled textual doc.
Re: Show HN: Programmatically Generate Diagrams for GitHub Readmes
#15I did a big heads down on this about 6 months ago as I was writing a paper and needed a ton of sequence diagrams to explain protocols.
PlantUML is a major pain. I didn't know about Mermaid at the time.
Latex has a ton of code for building better charts but they're all very very low level.
What's needed is a higher level abstraction here.
It should be possible to have much higher level charts without having to be a latex god.
Re: Show HN: Programmatically Generate Diagrams for GitHub Readmes
#16Readers may also want to check out nomnoml.com. It’s definitely a more stripped down version of Mermrender. I used it for my thesis paper and was happy enough with it. I’ll definitely be checking this tech out.
Re: Show HN: Programmatically Generate Diagrams for GitHub Readmes
#17mermaid-filter is also a great part in the tool-chain, especially with pandoc.
Cool!
Re: Show HN: Programmatically Generate Diagrams for GitHub Readmes
#18Question : how does the local embed link translate into an asset uploaded to github user content? https://camo.githubusercontent.com/461a806ab46b5db76dcb02048...
It would work the same way as imgur or another image hosting provider. The app is in it's beginning phases to show the concept, but I'm adding blob storage on Azure. The image would get interpolated no different than anything else.
Re: Show HN: Programmatically Generate Diagrams for GitHub Readmes
#19Unfortunately Github doesn't support Mermaid language natively. Meanwhile, I've created an extension (Firefox & Chrome) that adds support for it: https://github.com/BackMarket/github-mermaid-extension