Hier im Blog habe ich bereits mehrere Artikel zu „Markdown„, der vereinfachten Auszeichnungssprache, geschrieben. Im Beitrag „Markdown-Spickzettel zum herunterladen„ habe ich auch ein paar Editoren vorgestellt und wie man Markdown-Dokumente mit einer Erweiterung im Browser anzeigen lassen kann.
Seit dem Artikel habe ich mit den genannten Editoren ein wenig herumprobiert und war nicht wirklich zufrieden. Der einzige Editor, den ich nach wie vor super finde ist Joplin, den ich auf all meinen Geräte verwende, um Notizen, Einkaufslisten, etc. über meine Nextcloud zu synchronisieren.
Mittlerweile habe ich mich auch mehr mit Git und Gitea beschäftigt, um eine vernünftige Versionsverwaltung für meine Dateien und Skripte zu bekommen. Die Verwendung von Versionsnummern in der Dateibezeichnung ist manchmal ein wenig umständlich. Dabei habe ich auch einmal einen Git-Server auf meinem Synology NAS aufgesetzt, was ebenfalls wunderbar funktioniert hat.
Gib mir gerne einen Kaffee ☕ aus!
Wenn dir meine Beiträge gefallen und geholfen haben, dann kannst du mir gerne einen Kaffee ☕ ausgeben.
bc1qfuz93hw2fhdvfuxf6mlxlk8zdadvnktppkzqzj
Ich schreibe für mich auch immer eine kleine Dokumentation mit, wenn ich an meinen Systemen etwas ändere oder einen Spickzettel zur Verwendung von bestimmten Systemen oder Befehlen. Bisher habe ich das in einem einfachen Text-Editor, wie Notepad++, erledigt. Was seinen Zweck erfüllt hat, aber auch nicht so ansprechend zu lesen war, wenn man etwas gebraucht hat.
Mit Markdown habe ich eine neue Lösung für mich gefunden. Meine erstellten Anleitungen und Dokumentation schreibe ich mittlerweile in eine md-Datei, speichere sie für die Versionierung in einem Git-Repo und öffne die Dateien dann in einem Webbrowser meiner Wahl oder meinem neuen Markdown-Editor. Im Browser erfolgt der Aufruf der Datei mit einem gesetzten Lesezeichen. (Installation einer Erweiterung ist dafür notwendig Markdown-Spickzettel zum herunterladen)
Auch meine Beiträge für meinen Blog schreibe ich mittlerweile zuerst im Markdown-Editor bevor ich die in meine WordPress-Installation „überführe“.
Nach einigem Suchen und Ausprobieren bin ich auf den Editor „Typora“ ➡ https://typora.io/) gestoßen. Den Editor gibt es für die Plattformen Windows, MacOS, und Linux. Damit kann ich theoretisch sämtliche Dateien auf den unterschiedlichen Plattformen bearbeiten. Da Markdown-Dateien eigentlich nichts anderes sind als als Text-Dateien mit ein wenig speziellen Code, schicke ich die in die Versionsverwaltung Git und damit ist ein Sync auf unterschiedliche Endgeräte jederzeit einfach möglich, in beide Richtungen. Ich kann also meine Dateien jederzeit auf meinen Endgeräten bearbeiten und ändern und auf anderen Geräten den Stand abrufen und weitermachen. Die Änderungen lassen sich sehr einfach tracken. Für Laien ist das Lesen der Markdown-Dateien ebenfalls sehr einfach möglich, entweder über einen Webbrowser mit entsprechender Erweiterung, oder über einen Editor wie Typora.
In der Praxis nutze ich Typora nur auf meinem Windows-PC, aber die Möglichkeit für einen einfachen Übertrag auf andere Geräte mittels eines Git-Repos besteht. (Falls Interesse an einem kostenlosen Git-Repo besteht, schaut euch meinen Beitrag zu ➡ codeberg.org an.)
Nun noch ein paar Worte zu Typora.
- Typora ist kostenlos.
- Typora ist nur für Markdown und funktioniert sofort out-of-the-box.
- Der Quelltext ist nicht öffentlich verfügbar. Für mich aber kein Grund den Editor nicht zu nutzen. Das Programm ist aber kostenlos von der offiziellen Website herunterzuladen https://typora.io/
- Typora verwendet nur ein Fenster zum Schrieben und keine zwei, wie andere Editoren. Ihr tippt also Markdown-Syntax ein und das wird on-the-fly übersetzt und sofort richtig formatiert dargestellt. Das ist aus meiner Sicht auch ein großer Vorteil gegenüber Atom und Notepad++, die immer zwei Fenster benötigen. Eines mit der Markdown-Syntax und einmal ein formatiertes Fenster zur Darstellung der Ausgabe.
- Ein Umschalten in den Quellcode ist aber jederzeit möglich.
- Ein ablenkungsfreies Arbeiten ist durch die Darstellung in einem Fenster super. Ebenfalls ein Vorteil gegenüber Atom und Notepad++.
- Markdown-Syntax kann durch einen Rechtsklick mit der Maus an Stelle sehr einfach eingefügt werden.
- In der linken Sidebar lässt sich die Gliederung des Dokuments darstellen und auch zur Navigation, zum einfachen hin- und herspringen im Dokument nutzen.
- In der linken Sidebar lässt sich ein ganzen Ordner öffnen und die einzelnen Dateien anzeigen. Mit einem Mausklick lassen sich die Dateien dann öffnen und bearbeiten.
- Die Rechtschreibprüfung lässt sich sehr einfach aktivieren und ist auch vollkommen ausreichend für das Schreiben von längeren Dokumenten.
- Dokumente lassen sich mit Hilfe von Typora gleich in andere Datei-Formate exportieren, wie z.B. PDF, HTML, Word (.docx), OpenOffice, LaTeX, etc.
- Typora hat mehrere Themen an Bord mit denen sich die Darstellung schnell ändern lässt, z.B. in die bekannten GitHub-Formatierung oder einem Theme mit schwarzem Hintergrund (mein Favorit).
Hier sind noch ein paar Screenshots von Typora. Ich habe im Editor den ersten Entwurf für den Beitrag “ ➡ Eine WordPress-Testumgebung mit Oracle VirtualBox und Ubuntu erstellen“ verfasst.
Typora - a markdown editor, markdown reader
Mein oben dargestellter Workflow mit Markdown-Dateien und Git und der Darstellung im Webbrowser eurer Wahl erscheint mir auch ein sehr gutes Mittel, um in einem Projektteam sehr einfach Dokumentation zu erstellen und die dann über mehrere Teammitglieder mit Hilfe von Git / Gitea zu teilen. Durch die Versionierung ist immer gewährleistet, dass sehr einfach nachvollzogen werden kann wer, was geändert hat.

ist absolut technik-begeistert und großer Fan von Linux und Open Source. Raspberry Pi Bastler der ersten Stunde und nach wie vor begeistert von dem kleinen Stück Hardware, auf dem er tolle Projekte umsetzt. Teilt hier seine Erfahrungen mit Nextcloud, Pi-hole, YubiKey, Synology und openmediavault und anderen spannenden IT-Themen. Nutzt Markdown und LaTeX zum Dokumentieren seiner Projekte und Gitea zum Versionieren. Sitzt vor einem 49“ Monitor, nutzt Windows und MacOS zum Arbeiten, Linux auf seinen Servern und virtuellen Maschinen und hört dabei Spotify und MP3s und Radio-Streams über seinen RadioPi.