Auf Mastodon ansehen
Einführung in Markdown
Ich mache mir gerne Notizen. Diese können ein paar Links beinhalten oder eine einfache Liste. Immer häufiger dokumentiere ich so ganze Arbeitsvorgänge in meinem Berufsleben, um diese teilen zu können und das Wissen zu sichern. Mit dieser Motivation bin ich bereits vor Jahren über Markdown und dessen simple Formatierung gestolpert. Vorher habe ich Dokumentationen gerne in HTML geschrieben. Im hektischen Alltag bleibt mir jedoch meist keine Zeit, umständlich in HTML zu coden. Word oder ähnlich schwerfällige Programme machen es nicht besser, eine übersichtliche Dokumentation mit Gliederung zu erfassen.
Natürlich könnte ich dafür das geniale Tool LaTeX von Leslie Lamport hernehmen. Für meine Verwendung sehe ich dies jedoch als Overkill an. Zudem liest sich Markdown für mich in einem Editor einfach flüssiger.
Syntax und Flavours
Da sich Markdown im Verlauf der Jahre weiterentwickelt hat, gibt es mittlerweile eine gute Handvoll unterschiedliche Flavours. Sie basieren jedoch alle auf der ersten Definition, verfasst von John Gruber. Anbei eine Auswahl an Markdown-Flavours:
Archivieren
Textdateien können auch Jahrzehnte später noch geöffnet werden. Ebenso ist es daher auch mit Markdown. Für andere Dateiformate sieht es in dieser Hinsicht düsterer aus. Wer möchte ein drei Jahrzehnte altes Officedokument öffnen?
Markdown Evaluation
Meine ersten Gehversuche mit Markdown habe ich mit dem Editor Vim gemacht. Dieser eignet sich auch ganz gut dafür und verwendet dazu sogar etwas Farbe. Manchmal schreibe ich eine Readme in Markdown noch heute mit Vim. Wer jedoch eine Voransicht inklusive Bilder, ein Inhaltsverzeichnis zur Navigation und einige Features zusätzlich haben möchte, verwendet besser ein Programm, welches einzig und allein dafür geschrieben wurde. Richtig, ich verwende dazu weder Visual Studio Code noch irgendwelche anderen schwerfälligen, browserbasierten Sourcecode-Editoren, welche zudem noch meinen Content ungefragt an eine KI übergeben. Dafür ist mein lüfterloser Computer (digitales Zen!) sowieso zu schwach auf der Brust. Auch mit KI-Browser-Engine-all-in-one-Editoren kann Markdown geschrieben werden. Nur: Die Voransicht benötigt eine Ewigkeit zum Laden und hinkt.
Seit geraumer Zeit schreibe ich an einer sehr umfangreichen Dokumentation mit vielen SVG-Illustrationen. Möglicherweise entsteht daraus sogar ein eBook. Spätestens dann machte ich bei der Evaluation einiger Editoren, welche ich ausgetestet habe, gleich wieder kurzen Prozess: sudo apt purge damit! Nach all diesen Versuchen hat sich für mich Ghostwriter als einzige Lösung herauskristallisiert. Kostenpflichtige Programme (wie zum Beispiel Typora) liess ich bei meiner Evaluation übrigens nicht gelten. Obwohl ich praktisch ausschliesslich GTK-basierte Programme einsetze, habe ich noch keines mit demselben Funktionsumfang gefunden, um damit bequem und viel Markdown zu schreiben.
Installation
Wer nicht die allerneuste Version einsetzen will und keine Lust hat, den Sourcecode selber zu kompilieren, kann mithilfe von einem Einzeiler in der Terminal-Shell die Installation vornehmen. Unter Debian geht dies so:
sudo apt install ghostwriterMomentan hat sich noch ein Dependency-Problem eingeschlichen bei Debian Trixie. Damit die Icons in der GUI angezeigt werden, muss deshalb möglicherweise noch folgende Library nachinstalliert werden:
sudo apt install qt6-svg-plugins Übrigens müssen sich auch die Windows- und Apple-Jünger nicht beklagen. Für beide Systeme ist Ghostwriter ebenfalls erhältlich.
Und los gehts!
So sieht die GUI aus – aufgeräumt, schlicht und einfach. So sollte es sein, um frei von Ablenkung eine Dokumentation oder Notizen zu schreiben. Die linke Sidebar (genannt outline) sowie die Preview können nach Belieben ein- oder ausgeblendet werden.
Wer gerne Shortcuts verwendet, wird in der Dokumentation schnell fündig. Die Dokumentation ist dabei kurz gehalten und nicht überladen. Eigentlich so, wie es immer sein sollte.
Wer sein Dokument exportieren möchte, kann dies direkt aus Ghostwriter vornehmen. Dateiformate wie z.B. PDF, Richtext, Word, HTML oder ePub sind möglich – abhängig vom ausgewählten Markdown Converter.
Wer sein Markdown-Dokument nicht direkt von Ghostwriter aus exportieren möchte, kann dies auch mit Pandoc machen. Details und Beispiele erläutere ich wohl in einem späteren Beitrag. Ist dies interessant für dich?
Zu guter Letzt: Mit Markdown kannst du also mehr Inhalt schreiben und musst dich kaum ums Formatieren kümmern.
Quellen:
* [John Grubers Markdown Syntax](https://daringfireball.net/projects/markdown/syntax)
* [Pandocs Markdown](https://pandoc.org/MANUAL.html#pandocs-markdown)
* [Github Markdown Syntax](https://docs.github.com/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax)
* [Common Mark](https://commonmark.org/)
* [MultiMarkdown](http://fletcherpenney.net/multimarkdown/)
* [Markdown](https://en.wikipedia.org/wiki/Markdown)
* [Ghostwriter](https://ghostwriter.kde.org
* [Typora](https://typora.io)
* [Vim](https://www.vim.org/)
Hi! Hattest Du das auch mit retext verglichen?
Danke für den Tipp. Retext sieht auf den ersten Blick schon mal vielversprechend aus!
An Ghostwriter mag ich, dass ich ihn beruflich auch unter Windows verwenden kann (respektive muss) Vermutlich muss für retext die komplette Python Umgebung geschaffen werden unter Windows, damit's läuft. Hast du da schon Erfahrung gesammelt?
Was ich weiterhin an Ghostwriter mag:
Die Bedingung "Windows" ist ein wenig einschränkend bei der Auswahl. Was mich überrascht hat, Kubuntu 24.04 gönnt sich der Standard Ghostwriter 200 - 300 MB.
Wenn ich das vergleiche mit Mindforger https://github.com/dvorka/mindforger ebenfalls in C++ entwickelt, der gönnt sich 77 MB.
Trotz M.2 NVMe braucht der Ghostwriter 3 Sekunden und der Mindforger 1 Sek. um rasch etwas nachzuschauen oder zu notieren, Schätze ich die Geschwindigkeit.
:D es gibt sogar eine .exe
Gegebenenfalls könnte auch Manuskript etwas für dich sein. Es ist vor allem für das Schreiben von Romanen ausgelegt. Auch für Dokumentationen kann es geeignet sein. Die Beschreibung der Welt kann man für das Environment nutzen und den Charakter Tab für wiederkehrende Objekte die man verfolgen möchte. Ich habe es aber zugegeben schon seit 5 Releases nicht mehr genutzt.
Spannend, hätte nicht gedacht, dass es für Schriftsteller eine komplette Suite gibt. Das muss ich mir unbedingt zu Gemüte führen.
Hat unzählige Features - wobei ich nicht sicher bin, ob mir dies fast zu überladen vorkommt. Ist wohl immer eine Gratwanderung. Eine möglichst flinke Preview finde ich ebenfalls hilfreich. Wenn diese noch automatisch die Ansicht synchronisiert - umso besser!
Habe eine zeitlang Mardownpad für Windows genutzt. Was mir bei diesem Programm gefällt ist, dass in der Preview nur das zu sehen ist, was im Editor gerade sichtbar ist. Dies spart die Synchronität und einen Scrollbar ;-) Gibts sowas schon für Linux??
Grundsätzlich wird aber ein Editor (inkl. Markdown-Editor) immer eine Geschacksache sein. Mir gefallen grundsätzlich Editoren mit schlankem Sourcecode, welche auf möglichst vielen Platformen möglichst Absturzfrei laufen.
Eine Vorschau-Funktion ist die eine Sache, doch läßt sich die Vorschau auch editieren? Muss man in Ghostwriter immer alles in Markdown schreiben oder gibt es eine Funktionalität die gemachte Notizen direkt im WYSIWYG-Modus zu editieren? Vermutlich macht genau das https://typora.io/ so einzigartig und zum derzeit wahrscheinlich besten Markdown-Editor. Wer wirklich viel mit Markdown macht, sollte sich das unbedingt mal angucken und die Leute ggf. mit einem Kauf unterstützen. Ist zwar leider kein FOSS aber 15 Euro für eine immerhin lebenslang gültige Lizenz und ein Programm das Updates erhält sind IMHO recht angemessen und nicht überzogen. Zudem lassen sich alle Funktionen 2 Wochen kostenlos zum Testen benutzen und die Lizenz gilt dann wohl sogar plattformübergreifend (Linux, Windows, macOS).
Schade das Marktext https://github.com/marktext/marktext und TOAST UI Editor https://github.com/nhn/tui.editor nicht mehr weiterentwickelt werden.
Ein guter Online Markdown-Editor mit Live-Vorschau https://omf.ai/tools/markdown-editor/
Ich editiere lieber direkt in Markdown ohne integriertes WYSIWYG. Ist halt Geschmacksache.
Hallo!
Bin auch ein Markdown-Fan und bin immer an interessanten Markdown-Anwendungen interessiert. Gibt es eine Einstellung, wie ich Ghostwriter dazu bekomme, die Vorschau mit zu scrollen, wenn ich den Code scrolle? Das finde ich extrem praktisch!
Ich verwende ReText, eben weil die Vorschau mit scrollt und weil ich viel genutzte Export-Anweisungen zu pandoc direkt in das Menü einbinden kann. Wie hier beschrieben: https://www.h-felder.de/computer/markdown.html
LG, Wiesensohle
Leider synct Ghostwriter nicht. Werde dies mal reinkippen. Wenn jedoch auf einen Titel in der Sidebar geklickt wird, dann scrollt auch die Preview dorthin.
Danke für den Hinweis von retext. Hat retext einen Sdtebar, um die Dokumentstruktur darzustellen? Diesen möchte ich nicht mehr missen.
Ghostwriter ist in die "KDE Suite" aufgenommen worden. Dies gibt mir eine bestimmte Gewissheit, dass dieses Tool zumindest länger gepflegt wird als andere Markdown-Editoren. Solche gibt's mittlerweile wie Sand am Meer. Einfache, überladene, geforkte, absturzfreudige... Mark Text zum Beispiel wird leider nicht mehr weiter entwickelt. Dabei hätte es sich neben Typora als Opensource Alternative gut sehen lassen können.
Läuft retext unter Windows? Leider arbeite ich beruflich immer noch zu einem grossen Teil mit Windows...
Nein, ReText hat (noch) keine Sidebar. Das wäre grundsätzlich praktisch, aber mir persönlich fehlt das nicht, weil ich sehr lange Texte eh mit Manuskript oder Zettlr schreibe.
Windows? Keine Ahnung… kann man unter Win mit "pip" installieren? Dann vermutlich ja…
Das Schöne an Markdown ist ja, daß Du mit Pandoc problemlos auch Latex Dokumente, HTML, (auch komplexe) Word Dokumente, LO Writer, Powerpoint u.s.w. erzeugen kannst.
Es ist also eine ganze Reihe unterschiedlicher "Workflows" denkbar. Es gibt eine ganze Reihe unterschiedlicher Schalter und Template Optionen, die man sich zurecht legen kann.
PS: Als "Editoren" werfe ich zusätzlich mal 'scite' oder 'retext' in den Ring. 'Geany' kenne ich natürlich auch, 'ghostwriter' aber bislang noch nicht. 'Scite' läuft natürlich (fast?) überall.
Danke für den Beitrag! Hast Du Joplin auch evakuiert? Verwende ich für alle meine Notizen und lässt sich einfach mit Nextcloud über alle Geräte synchronisieren.
Ich suche nach einer Alternative für MS Notes; brauche es jedoch als Webanwendung, nicht als Application, da ich auf meinem beruflichen Rechner keine Software ausführen kann. Gibt es gute Markdown-Webapps für Nextcloud, die das leisten? Joplin, Obsidian & Co sind -soweit mir bekannt- nicht an Webapp verfügbar.
Angesichts der zahlreichen konkurrierenden Markdownstandards scheint mir org-mode (gibts auch für Vim) die weniger schlechte, weil: kohärentere Wahl zu sein.
Interessant. Org-Mode kannte ich noch nicht. Ich halte mich momentan an das Pandoc flavour, da ich Pandoc verwende um das ePub zu erzeugen. Ebenfalls beinhaltet das markdown file bei mir einen YAML header. https://pandoc.org/MANUAL.html#epub-metadata
Ich finde es praktisch, alle notwendigen Dinge zusammen in einem File zu halten.
Ja, oder man macht es der Kernel-Doku nach und nimmt asciidoc … (was pandoc ebenfalls versteht).
Hallo und danke für die Info. Ich habe es mir angesehen, werde aber dennoch bei Kate bleiben, ist auch einfach gehalten, kann aber wesentlich mehr.
Mit Kate habe ich leider kein Glück: SVG-Grafiken in der Preview anzeigen (ok, als HTML tags aufgeführt) mag Kate nicht anzeigen. Mit den unterdessen 37'000 Wörter verschluckt sich die Preview ab einem bestimmten Punkt ebenfalls. Ab diesem Punkt kommen nur noch Aufzählungszeichen ohne Text. Fehler oder Warnings werden keine aufgeführt...
Fall es Debian (Trixie-)User hilft - für die Preview musste ich noch
sudo apt install markdownpartausführen, damit überhaupt etwas angezeigt wird in der Preview..Ich habe jetzt mal Ghostwriter installiert und das schreiben gefällt mir sehr gut weil ablenkungsfrei. Aber mir ist aufgefallen das man scheinbar nicht direkt aus Ghostwriter drucken kann. Es muss immer erst exportiert werden ? Wenn man das macht sehe ich entweder HTML oder zig verschiedene markdown "dialekte" wobei man nicht weiss was das passende ist. Vielleicht wäre ein extra Artikel von Ghostwriter Profi Ralf dazu hilfreich
Du könntest PDF exportieren. Noch einfacher: Nimm das recht gute PDF-Anzeige-Programm Okular = Markdown-Datei reinziehen und drucken. Fertig.
Ja ich kenne Okular aber ich finde es doch schon etwas umständlich den Weg über PDF zu gehen. In Nextcloud kann man ja auch eine .md Datei direkt drucken. Und dann noch die lange Liste der verschiedenen md formate die beim exportieren aufgeht............................
Nein - Du musst keine PDF exportieren. Du ziehst die Markdown-Datei direkt in Okular und druckst. - Ja, ist ein bisschen umständlich. Vermutlich gehen die Entwickler von der eigentlichen Intention von Markdown aus - die Auszeichnungssprache ist ja gerade nicht für den Ausdruck gedacht - Ziel sind die unterschiedlichen Monitorgrößen.
Danke für den Tip, mit Okular ein Markdown-File zu öffnen. Die Preview ist sehr brauchbar und performant. Sogar ePub scheint zu funktionieren.
Mit nachfolgendem HTML-tag hat dann Okular im Unterschied zu Ghostwriter einige Mühe: ``
An Ghostwriter mag ich, dass unter dem Menu Preview Options das anzuzeigende Markdown-Flavour ausgewählt werden kann. Wenn man sich mal für ein Flavour entschieden hat, ist dies sehr hilfreich.
Ansonsten arbeitet man vermutlich besser mit ASCII-DOC oder ORG, welche offenbar eine eindeutige Syntax kennen.
Übrigens hat auch Zettlr mit HTML tags einige Mühe. Bei anderen Programmen funktioniert nicht mal ein HTML Kommentar wie: ``
Da hört bei mir die Evaluation gleich wieder auf ;-)
da wurde was unterdrückt in meinem Kommentar oben:
Jeder vernünftige Markdown Editor sollte aus meiner Sicht Kommentare richtig interpretieren und in der Preview ausblenden. Beispiel hier aufgeführt: https://wiki.selfhtml.org/wiki/HTML/Tutorials/Element,_Tag_und_Attribut#Kommentare
Auch img-tags mit stylesheet sollte die Preview nach Möglichkeit unterstützen. Zum Beispiel sowas:
style="height:3em;float:left;margin-right:1em