Github é uma das plataformas mais populares entre os desenvolvedores, ela é responsável pelo controle de versão através do Git, além de implementar incríveis novas funcionalidades. Desde que a Microsoft fez a compra da plataforma, ela vem ganhando atualizações substanciais com base nas necessidades dos seus usuários.
Uma das novas atualizações é o suporte a marcação Mermaid, que pode ser inserido no README.MD, possibilitando criar incríveis diagramas, desde os mais simples até alguns mais complexos, como diagramas de sequência e pizza, por exemplo.
O arquivo README.MD é um dos principais arquivos do projeto quando o assunto é descrever como a aplicação funciona e o que é necessário para executá-la, dispensando assim, a necessidade de criar documentos fora do escopo do projeto para esse tipo de tarefa. Agora com a marcação Mermaid, podemos deixar ainda mais completo essas informações, como, por exemplo, mostrar um fluxo de passos necessários para executar uma determinada tarefa.
Caso você esteja utilizando o Visual Studio Code, então recomendo que instale a extensão Markdown Preview Mermaid Support, assim você consegue visualizar a marcação no seu editor antes de comitar para o seu repositório oficial.
Abaixo podemos ver uma demonstração de um simples gráfico com a leitura da esquerda para a direita.
```mermaid
flowchart LR
A[Usuário] -->|Clica em comprar| B(Compra)
B --> C{Produto já comprado}
C -->|true| D[Cancela compra]
C -->|false| E[Efetiva compra]
```Agora vem a parte mais interessante, não é necessário instalar nenhuma extensão no navegador nem mesmo habilitar nada na plataforma do Github, basta inserir as marcações e comitar o seu arquivo readme.md para utilizar essa nova funcionalidade.
Toda a documentação e exemplos do formato Mermaid pode ser encontrado no seu repositório oficial no próprio Github.
Agora diz para a gente aqui nos comentários, como essa nova funcionalidade vai te ajudar.
Deixe um comentário