Markdown & Editor

Es gibt noch genug Menschen in der IT-Welt, die nicht wissen, was Markdown ist. Um ehrlich zu sein, bis Ende 2018 wusste ich selbst nicht. Die Sache begann damit, dass wir von HPE Scripte bekommen haben, für die Erstellung eines OpenShift 3.11 Clusters (Multimaster/Multinode). Dabei handelte es sich um Ansible-Scripts und deren „Dokumentation“ erfolgte in Dateien, die mit .md endeten. Das hat mich etwas stutzig gemacht, worauf ich im Internet recherchiert habe, was es mit diesen md-Dateien auf sich hat. Schnell fand ich heraus, das es sich dabei um Markdown handelte und das die erhaltenen MD-Dateien fehlerhaft waren, wie auch die Ansible-Scripts, die wir erhalten haben. Kurzum: HPE hat weder das eine, noch das andere richtig gemacht.

Dennoch fand ich Markdown sehr interessant, schaute mir das Thema etwas genauer an und seitdem ist es in unserem OpenShift-Team, im Verwendung. Ob das nun einfache Notizen sind, Howtos oder kleine Dokumentationen, wir verwenden dafür Markdown. Privat sieht es bei mir nicht anders aus.

Die Vorteile von Markdown sind:

  • Leicht zu lernen
  • Lesbar in jedem Editor (vi/vim, nano, geany, Notepad++, etc.)
  • Export in HTML, PDF uvm. (Editor abhängig)
  • Dateien sind klein und immer lesbar

Nachteile habe ich ehrlich gesagt noch keine gefunden, ggf. kann man HTML-Code verwenden. Bei größeren Dokumentationen bzw. Handbüchern würde ich aber eher zu LaTeX oder ähnlichen greifen. Word/OpenOffice eher nicht, da hier Code immer falsch dargestellt wird. Wobei, wenn man MD als PDF exportiert, kann das ebenfalls passieren, da die Zeilen auf Papier beschränkt sind. Hier ist mit Zeilenumbruch zu arbeiten wie man es aus IT-Büchern gewohnt ist. Wenn das Ziel aber eine druckbare Dokumentation ist, sollte man vielleicht doch lieber gleich zu LaTeX oder einer Alternative greifen, wo man Texte sinnvoll formatieren kann.

Zum Thema Editor

Es gibt viele Editoren, ich habe auch einige probiert. In der Shell/bash verwende ich den vi/vim-Editor (ohne Plugins). Auf der Arbeit haben wir uns für Visual Studio Code mit entsprechenden Plugins geeinigt (wobei ich selbst kein Fan davon bin). Privat habe ich nach langem probieren, seit kurzen nun den typora-Editor im Einsatz. Den gibt es für Linux, Windows und MacOS. Letzteres noch als Beta. Unter Linux verwende ich ihn auf Ubuntu 19.04.

typora kann nicht nur in HTML und PDF exportieren, sondern sogar in LaTeX, Word, OpenOffice, Epub, als Image, Mediawiki, uvm. Der Editor an sich ist minimalistisch, was ich persönlich als sehr angenehm empfinde.

Im IT-Umfeld lohnt es sich meiner Meinung nach, sich mit Markdown auseinanderzusetzen. Die Einarbeitungszeit ist nicht der Rede Wert, bei Fragen hilft das Netz. Man findet im Grunde alles, was man braucht: Tabellen, Code in einem Feld, Code mitten im Satz, eine einzelne Code-Zeile. Wobei mit Code ich auch Befehle in der Shell/Command meine. Man kann Überschriften, Inhaltsverzeichnisse, Auflistungen, uvm. erstellen. Ein einfaches Markdown-Beispiel findest Du z.B. HIER.

Links

Schreibe einen Kommentar

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

*

code