GitHub har lagt till inbyggt stöd för Mermaid – vilket gör det möjligt för utvecklare att snabbt generera diagram.
Enligt GitHub ser både open source- och företagsutvecklare en produktivitetsökning på cirka 50 procent när de förses med detaljerad dokumentation. Rika, visuella format hjälper ofta till att presentera information bättre.
Förra månaden lade GitHub till stöd för .svg-filer till kommentarer i frågor, PR, diskussioner och Markdown-filer som README. GitHub säger dock att det inser behovet av att kunna hålla diagram uppdaterade och enkelt skapa dem.
JavaScript-baserat diagram- och diagramverktyg Mermaid tar Markdown-inspirerade textdefinitioner och skapar diagram dynamiskt i webbläsaren.
GitHub har nu lagt till stöd för Mermaid så att utvecklare kan skapa grafer med enkel syntax som:
“` sjöjungfru graf TD; A–>B; A–>C; B–>D; C->D; “`
Vilket i sin tur kommer att skapa följande diagram:
Det resulterande diagrammet är enkelt att redigera om det behövs, vilket gör att utvecklare slipper skapa och ladda upp nya .svg-filer för att visa information visuellt.
En live Mermaid-redigerare med exempeldiagram finns här.
Vill du förnya din digitala transformationsstrategi? Lär dig mer om Digital Transformation Week som äger rum den 11-12 maj 2022 och upptäck nyckelstrategier för att göra dina digitala insatser till framgång.
Utforska andra kommande företagsteknologievenemang och webbseminarier som drivs av TechForge här.
