# Include diagrams in your Markdown files with Mermaid | The GitHub Blog

<https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/>

- Host: [github.blog](https://links.thingelstad.xyz/hosts/github.blog/)
- Saved: February 17, 2022 (2022-02-17T23:48:04Z)
- Record: https://links.thingelstad.xyz/links/96a6be12f50f/
- JSON: https://links.thingelstad.xyz/links/96a6be12f50f.json

## What Jamie wrote

The most notable thing about this is that GitHub is supporting it so it will be very easy to use. It looks like Mermaid uses the standard [DOT graph description language](https://en.wikipedia.org/wiki/DOT_%28graph_description_language%29) to describe these images. DOT is a powerful tool and a good choice for this. The way that GitHub is rendering these is very polished as well.

There is an interesting extension to go with this — using code to generate the DOT notation and then feed it into GitHub. it would be curious to do software analysis that generates large volumes of DOT files and then puts them on GitHub to render and display. 🤔

## Facts

- Kind: [Page](https://links.thingelstad.xyz/kinds/page/)

## Appears in

- [WT212: Weekly Thing #212 / Words, Mermaid, Beats](https://weekly.thingelstad.com/archive/212/), Notable

## Same host

- [Highlights from Git 2.28 - The GitHub Blog](https://links.thingelstad.xyz/links/367335e97755/) (github.blog, August 23, 2020)
- [Nbdev: A literate programming environment that democratizes software engineering best practices - The GitHub Blog](https://links.thingelstad.xyz/links/7086f03175cd/) (github.blog, November 24, 2020)
- [Leveraging machine learning to find security vulnerabilities | The GitHub Blog](https://links.thingelstad.xyz/links/3e5880ed7da6/) (github.blog, February 17, 2022)
- [Why Python keeps growing, explained | The GitHub Blog](https://links.thingelstad.xyz/links/38b72e50a28d/) (github.blog, March 2, 2023)
- [Inside GitHub: Working with the LLMs behind GitHub Copilot | The GitHub Blog](https://links.thingelstad.xyz/links/abddd7301c40/) (github.blog, May 18, 2023)

## Saved the same week

- [‘We Need to Oppose Russia’: Ukrainians Find Common Purpose](https://links.thingelstad.xyz/links/54d5e52ee9d5/) (nytimes.com, February 17, 2022)
- [Event Notes in Craft Are Awesome for Time Blockers](https://links.thingelstad.xyz/links/eda1e32a4347/) (thesweetsetup.com, February 17, 2022)
- [The simple system I’m using to stay in touch with hundreds of people – Jakob Greenfeld](https://links.thingelstad.xyz/links/0b0719531dfc/) (jakobgreenfeld.com, February 17, 2022)
- [What using RSS feeds feels like](https://links.thingelstad.xyz/links/ab16d2be1b74/) (gilest.org, February 17, 2022)
- [Medieval Fantasy City Generator](https://links.thingelstad.xyz/links/7c6edcc1a57e/) (watabou.github.io, February 17, 2022)

## Elsewhere

- Wayback Machine: https://web.archive.org/web/*/https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/