MARKDOWN

Eines der wichtigsten Themen, egal ob in einem großen Projekt oder bei einem kurzen Einzeiler, ist die Dokumentation. Meist kommt diese vor allem bei Administratoren zu kurz. Ich habe meist keine Lust lange Word Dokumentationen zu schreiben. Da mittlerweile VS-Code zu meinem Standard Editor geworden ist, fällt es mir leichter gleich in diesem die Dokumentation mithilfe der MARKDOWN Syntax zu erstellen. Entsprechende Erweiterungen gibt es zu genüge.

Wie der Name schon sagt, ist MARKDOWN ein markup Sprache. Im Gegensatz zu anderen erfüllt MARKDOWN einer immer größer werdenden Beliebtheit. Ein Vergleich mit Word oder Liebre Office Writer ist nicht möglich, dieser WYSIWYG Ansatz ist bei MARKDOWN nicht gegeben. Für die Meisten Einsatzbereiche ist eine so große Fülle an Designmöglichkeiten nicht notwendig. Zum Erstellen einer .md oder .markdown Datei sind keine speziellen Editoren notwendig, zum Anzeigen wird jedoch eine entsprechende App benötigt. In einigen Editoren wie VS-Code ist ein solcher Interpreter schon integriert. In diesem Blog geht es um die Dokumentation mithilfe von MARKDOWN, die Sprache bietet jedoch wesentlich mehr Möglichkeiten, wie das Erstellen von Präsentationen, Notizen oder Email Nachrichten. Für die einzelnen Einsatzzwecke gibt es eine Reihe von Projekten auf GitHub und Gitlab. Diese beiden Plattformen beherbergen sicherlich auch die meisten .md Dateien. Denn in der Regel werden Dokumentationen von Git- Repos in README.md Dateien gespeichert. Vorteil ist, dass diese Sourcecode Anbieter einen entsprechenden Interpreter bereitstellen und die Einbindung in die Website dadurch ermöglichen. Wieso sollte man sich nun einmal diese Art der Dokumentation anschauen ? Zum einen ist es die Nutzung von MARKDOWN in der Programmierung und Scripting ein etablierter Ansatz. Zum anderen ist die Syntax leicht zu erlernen und mithilfe von Editoren kann eine Umsetzung von viel schneller erfolgen. Dadurch das es Interpreten für jede Plattform gibt, ist hier keine Bindung an ein bestimmtes OS notwendig.

Über Andreas Bittner

MCSA Server 2016, MCSA Server 2012R2, Exchange 2010 & SharePoint Devop
Dieser Beitrag wurde unter Allgemein, Configuration veröffentlicht. Setze ein Lesezeichen auf den Permalink.

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.

*

Diese Website verwendet Akismet, um Spam zu reduzieren. Erfahre mehr darüber, wie deine Kommentardaten verarbeitet werden.