GitHub-Blöcke: JavaScript-Code in Markdown-Dateien.

Eine der ruhigeren Ankündigungen bei der jüngsten Veranstaltung von GitHub Universe war GitHub Blocks, das von Kyle Daigle, VP Strategy, als Experiment vorgestellt wurde, obwohl das Projekt so weit fortgeschritten ist, dass sich Entwickler auf eine Warteliste eintragen können.

Blöcke ermöglichen es Entwicklern, JavaScript in Repository-Dateien einzufügen, sodass sie zu Live-Dokumenten werden, die beispielsweise Inhalte visualisieren oder Analysen in Bezug auf das Repository präsentieren können. Daigle beschrieb es als „eine Möglichkeit, direkt und interaktiv mit Ihren Repos in Kontakt zu treten“.

Die Idee wurde in erster Linie für eine reichhaltigere Dokumentation präsentiert. „Blöcke sind Komponenten, die anpassen, wie Sie mit Ihren Inhalten interagieren“, sagte Daigle von Universe und fügte hinzu, dass ein Block „so leistungsfähig sein könnte wie eine Live-Code-Sandbox für einen WYSIWYG-Editor“ – oder mit anderen Worten, eine Art zu laufen und zu demonstrieren was der Code in einem Repository tut, innerhalb des Repositorys selbst. Sie können sich Blocks, so Daigle, als „kleine Apps vorstellen, die Sie bereitstellen, indem Sie sie auf GitHub pushen“.

Die Dokumentation für GitHub-Repositories wird meistens mit Markdown formatiert, einer einfachen Methode zum Hinzufügen von Markup, die einfach zu erstellen und als Klartext leicht lesbar sein soll und gleichzeitig wichtige Formatierungen wie Überschriften, Listen, Bilder und Codebeispiele bereitstellt.

Markdown hat eine Reihe von Varianten und die Version von GitHub, die GFM (GitHub Flavored Markdown) heißt , ist hier angegeben , eine Obermenge von Markdown.

Die Idee, JavaScript zu Markdown hinzuzufügen, steht etwas im Gegensatz zum Markdown-Konzept, obwohl die Idee nicht neu ist. GitHub-Blöcke erinnern an R Markdown , mit dem Programmierer R-Sprachcode und Shiny-Widgets einbetten können, wobei Shiny eine Komponente ist, die JavaScript, HTML und CSS ausführt.

Zu den von Daigle vorgestellten Anwendungsfällen gehören das Rendern von Schriftarten und Farben, das Anzeigen von JSON-Daten in formatierten Tabellen, das Anzeigen von Repository-Analysen wie Mitwirkende, Problemstatistiken, Commits und Pull-Anforderungen, das Anzeigen von Diagrammen und das dynamische Demonstrieren von Anwendungsfunktionen. Diese letzte Funktion eignet sich am besten für Anwendungen, die selbst in JavaScript oder TypeScript codiert sind, wie es häufig der Fall ist. Eine andere Möglichkeit besteht darin, die Codesuche und Indexierung aus der Dokumentation heraus zu generieren.

GitHub hat bereits eine REST-API, und in gewisser Weise verbindet Blocks dies lediglich mit der Idee, JavaScript und HTML von GFM aus rendern zu lassen. Konzeptionell stört es jedoch die Vorstellung, dass ein Repository für Code ist und dass das Kompilieren und Ausführen des Codes an anderer Stelle stattfindet, da der Code in diesem Fall direkt aus dem Repository ausgeführt wird.

Blocks ist eine GitHub-spezifische Funktion, und wenn sich Entwickler darauf verlassen, wird es schwieriger, zu einem anderen Code-Repository zu wechseln, ein weiterer Aspekt des Experiments, der sich als Vorteil für GitHub erweisen könnte. Weitere Informationen und die Bewerbung für die Warteliste finden Sie hier .