Auparavant, les développeurs intégraient une image sur Github pour afficher les diagrammes dans leurs fichiers Markdown. Maintenant c’est fini !! Vous pouvez utiliser un diagramme versionné dans un fichier README de Github de plusieurs façons.
Github permettra aux développeurs d’inclure des diagrammes et des organigrammes générés à l’aide de Mermaid, un outil de création de diagrammes et de graphiques basé sur JavaScript, dans des fichiers Markdown . Les développeurs constatent une augmentation de la productivité d’environ 50 % grâce à une documentation facile à trouver.
Auparavant, les développeurs avaient l’habitude d’intégrer une image sur Github dans leurs Markdown, et la mise à jour des diagrammes était très compliqué.
Mermaid crée automatiquement des diagrammes et des visualisations à l’aide de texte et de code. Des organigrammes, des graphiques UML, Git, et même le redoutable diagramme de Gantt peuvent être créés.
Github génère une iframe lorsqu’il rencontre les blocs de code marqués comme Mermaid. L’ iframe prend la syntaxe brute de Mermaid et la transmet à Mermaid.js, qui à son tour transforme le code en diagramme.
Représentation visuelle du pipeline de Mermaid :
```mermaid
graph TD;
A-->B;
A-->C;
B-->D;
C-->D;
```
sequenceDiagram
participant Alice
participant Bob
Alice->>John: Hello John, how are you?
loop Healthcheck
John->>John: Fight against hypochondria
end
Note right of John: Rational thoughts <br/>prevail!
John-->>Alice: Great!
John->>Bob: How about you?
Bob-->>John: Jolly good!
Laisser un commentaire