Antes, a única maneira de incluir imagens e diagramas em arquivos Markdown no GitHub era incorporarando uma imagem. Com a sintaxe Mermaid agora disponível, os usuários do GitHub podem compartilhar informações através de formatos visuais ricos, resultando no melhor gerenciamento e qualidade do projeto e melhor fluxo de trabalho. Dados do relatório anual Octoverse de 2021 do GitHub, mostram que os desenvolvedores vêem um aumento de produtividade de 50% quando a documentação é detalhada e disponível em diferentes formatos.

Mermaid é uma ferramenta de diagramação em JavaScript que toma definições de texto inspiradas em Markdown e cria diagramas de forma dinâmica no navegador. É uma ferramenta de criação para todos e suporta diferentes tipos de diagramas para projetos de software, incluindo fluxogramas, UML, gráficos Git, diagramas de jornada do usuário e até mesmo o temido gráfico de Gantt.

Funciona da seguinte maneira: ao identificar blocos de código marcados como mermaid, é gerado um iframe que pega a sintaxe bruta de Mermaid e passa para Mermaid.js, transformando esse código em um diagrama em seu navegador local.

Confira aqui (em inglês) outros detalhes sobre o suporte.