GitHub hat das JavaScript-basierte Diagramm- und Charting-Tool Mermaid fest integriert. Development-Teams können fortan ihre Fluss-, UML-, Git- oder auch Gantt-Diagramme inline mithilfe der Mermaid-Syntax erstellen.
Dank Erkennung der Mermaid-Syntax ist es künftig möglich, Diagramme direkt in der Dokumentation bei Github anzuzeigen.
(Bild: GitHub)
Mermaid ist ein JavaScript-basiertes Diagramm- und Charting-Tool, das Markdown-inspirierte Textdefinitionen übernimmt und Diagramme dynamisch im Browser erstellt. Es wird von Knut Sveidqvist gepflegt und unterstützt eine Reihe verschiedener gängiger Diagrammtypen für Softwareprojekte, darunter Flussdiagramme, UML, Git-Diagramme, User-Journey-Diagramme und sogar das gefürchtete Gantt-Diagramm.
An der integrierten Diagramm-Funktion hat GitHub gemeinsam mit Knut Sveidqvist, Betreuer des Mermaid-Projekts, sowie der CommonMark-Community gearbeitet. Enthält ein GitHub-Projekt Codeblöcke mit Mermaid-Markierung, so zeigen Clients, die Inhalte mit eingebettetem Mermaid in einer Nicht-JavaScript-Umgebung anfordern (z. B. eine API-Anfrage), den ursprünglichen Markdown-Code.
In einer JavaScript-fähigen Umgebung wird hingegen ein iFrame erzeugt, der die Syntax übernimmt und an Mermaid.js weitergibt, um den Code in ein Diagramm im lokalen Browser zu verwandeln. Dieser zweistufige Prozess läuft unter Zuhilfenahme der HTML-Pipeline von GitHub und dem Dateirendering-Dienst Viewscreen ab. Nachdem der Ursprungscode verarbeitet wurde, verweist das src-Attribut des iFrame auf den Viewscreen-Dienst.
GitHub zufolge hat das gleich mehrere Vorteile. So wird die JavaScript Payload dank der ausgelagerten Bibliothek klein gehalten. Außerdem reduziere das asynchrone Rendering der Diagramme den Overhead, der durch die Darstellung mehrerer Diagramme vor dem Senden der kompilierten ERB-Ansicht an den Client entsteht. Und zu guter Letzt hätten die in ein iFrame gepackten Inhalte weniger Schadpotenzial.
Im Endergebnis entstünden schnelle, leicht bearbeitbare und vektorbasierte Diagramme direkt in der Dokumentation. Wer mehr darüber erfahren möchte, kann die Mermaid-Webseite besuchen oder den offiziellen Mermaid Guide (Paperback) bestellen (Mermaid-eBook bei Amazon erhältlich).
Aufklappen für Details zu Ihrer Einwilligung
Stand vom 30.10.2020
Es ist für uns eine Selbstverständlichkeit, dass wir verantwortungsvoll mit Ihren personenbezogenen Daten umgehen. Sofern wir personenbezogene Daten von Ihnen erheben, verarbeiten wir diese unter Beachtung der geltenden Datenschutzvorschriften. Detaillierte Informationen finden Sie in unserer Datenschutzerklärung.
Einwilligung in die Verwendung von Daten zu Werbezwecken
Ich bin damit einverstanden, dass die Vogel IT-Medien GmbH, Max-Josef-Metzger-Straße 21, 86157 Augsburg, einschließlich aller mit ihr im Sinne der §§ 15 ff. AktG verbundenen Unternehmen (im weiteren: Vogel Communications Group) meine E-Mail-Adresse für die Zusendung von redaktionellen Newslettern nutzt. Auflistungen der jeweils zugehörigen Unternehmen können hier abgerufen werden.
Der Newsletterinhalt erstreckt sich dabei auf Produkte und Dienstleistungen aller zuvor genannten Unternehmen, darunter beispielsweise Fachzeitschriften und Fachbücher, Veranstaltungen und Messen sowie veranstaltungsbezogene Produkte und Dienstleistungen, Print- und Digital-Mediaangebote und Services wie weitere (redaktionelle) Newsletter, Gewinnspiele, Lead-Kampagnen, Marktforschung im Online- und Offline-Bereich, fachspezifische Webportale und E-Learning-Angebote. Wenn auch meine persönliche Telefonnummer erhoben wurde, darf diese für die Unterbreitung von Angeboten der vorgenannten Produkte und Dienstleistungen der vorgenannten Unternehmen und Marktforschung genutzt werden.
Falls ich im Internet auf Portalen der Vogel Communications Group einschließlich deren mit ihr im Sinne der §§ 15 ff. AktG verbundenen Unternehmen geschützte Inhalte abrufe, muss ich mich mit weiteren Daten für den Zugang zu diesen Inhalten registrieren. Im Gegenzug für diesen gebührenlosen Zugang zu redaktionellen Inhalten dürfen meine Daten im Sinne dieser Einwilligung für die hier genannten Zwecke verwendet werden.
Recht auf Widerruf
Mir ist bewusst, dass ich diese Einwilligung jederzeit für die Zukunft widerrufen kann. Durch meinen Widerruf wird die Rechtmäßigkeit der aufgrund meiner Einwilligung bis zum Widerruf erfolgten Verarbeitung nicht berührt. Um meinen Widerruf zu erklären, kann ich als eine Möglichkeit das unter https://support.vogel.de abrufbare Kontaktformular nutzen. Sofern ich einzelne von mir abonnierte Newsletter nicht mehr erhalten möchte, kann ich darüber hinaus auch den am Ende eines Newsletters eingebundenen Abmeldelink anklicken. Weitere Informationen zu meinem Widerrufsrecht und dessen Ausübung sowie zu den Folgen meines Widerrufs finde ich in der Datenschutzerklärung, Abschnitt Redaktionelle Newsletter.