Obsidian Markdown-Text – Obsidian Tutorial 4

Ich habe bereits mehrmals erwähnt, dass Obsidian als Basis Markdown-Text verwendet. Markdown ist eine einfache Auszeichnungssprache, deren wesentliches Ziel es ist, unmittelbar – also mit allen Codes und ohne ein dazwischen geschaltetes Konvertierungsprogramm – schreib- und lesbar zu sein.

Markdown ist 2004 von John Gruber für die Text-zu-HTML Umwandlung speziell zum Schreiben für das Web entwickelt worden. Inzwischen ist Markdown wegen seiner leichten Erlernbarkeit und seiner vielfachen Nutzbarkeit extrem weit verbreitet.

Trotzdem stellt sich die Frage, wieso eine weitere Auszeichnungssprache gelernt werden soll und nicht einer der traditionellen WYSIWYG Editoren verwendet wird.

Markdown-Text hat gegenüber anderen Formate vier wesentliche Vorteile:

Markdown-Text ist portabel: Markdown-formatierte Dateien können von allen anderen Editoren geöffnet und gelesen werden. Das ist ein starker Kontrast zu den häufig proprietären Dateiformaten anderer Software. Sie können jederzeit das Programm wechseln und alle ihre Markdown-Dateien weiter nutzen.
Markdown-Text ist Geräte-neutral: Eine Markdown-Datei mit der Endung .md oder .markdown ist auf Betriebssystem-Ebene eine normale Textdatei und daher auf allen Geräten und Betriebssystemen nutzbar.
Markdown-Text ist zukunftssicher: Ein Wechsel zu anderen Editier-Programmen ist sehr einfach. Passt Ihnen Ihr Markdown Editor nicht mehr, z.B., weil neuerer, besserer auf dem Markt ist, oder er nicht mehr weiter entwickelt wird, verwenden Sie einfach einen anderen Editor.
Markdown-Text ist weit verbreitet: Sehr viele Programme unterstützen Markdown. Markdown kann nicht für das Schreiben im Web genutzt werden, sondern auch für Artikel, Berichte, Notizen, Bücher, Präsentationen, eMails, Dokumentationen usw.

Symbol für Markdown-Text ist ein rechteckig umrandetes "M", das links neben einem Abwärtspfeil steht. — Das Symbol für Markdown-Text

Anwendungsfälle für Markdown-Text

Es gibt praktisch kein Einsatzgebiet, wo nicht auch Markdown-Text angewendet werden kann. Unter der Zwischenüberschrift What's Markdown Good For? beschreibt die Webseite markdownguide.org eine stattliche Reihe von Anwendungsfällen: Webseiten, Dokumente, Notizen, Bücher, Präsentationen, eMails, Zusammenarbeit, Dokumentationen.

Ich habe hier nur die Einsatzgebiete aufgezählt. Die obige Adresse verlinkt jedoch auch zu besonders interessante Applikationen, von denen ich nur einige aus meiner eigenen Erfahrung erwähnen möchte:

Statische Website-Generatoren

Praktisch alle der 347 statischen Website-Generatoren unterstützen auch Markdown-Text. Bereits 2017 habe ich die Gründ der wachsenden Beliebtheit von statischen Website-Generatoren geschrieben. Für neuere, mehr technische Details siehe den Blog Eintrag von Netlify, einem Service, das – mit einen sehr generösen Freemium-Modell, das für die meisten privaten Anwendungen reicht – auf die Verarbeitung von statischen Website-Generatoren spezialisiert ist.

Die oben erwähnt Webseite makrdownguide.org hebt besonders Jekyll, hervor. Einerseits weil es mit 45.696 Github Stars sehr beliebt ist (4. Stelle), andererseits aber auch weil mit den GitHub Pages eine sehr prominente Applikation Jekyll in einem Freemium-Modell inklusive benutzerdefinierter Domänen für die Publikation von Webseiten nutzt.

Ich selbst nutze Hugo (64.086 GibtHub Stars) in Zusammenhang mit dem auf Datenanalyse und Präsentation spezialisierten Markdown "Dialekt" R Markdown basierenden blogdown für meine englische Webseite Thought Splinters.

Im Zusammenhang mit Blogs möchte ich noch erwähnen, dass auch WordPress.com Markdown-Text unterstützt, bzw. wenn Sie WordPress selbst hosten, können Sie mit dem JetPack Plugin ebenfalls Markdown-Text nutzen. Es gibt auch eine Vielzahl von WordPress Erweiterungen für Markdown-Text, allerdings sind viele nicht mit der neuesten Version getestet oder haben niedrige Installationszahlen.

Dokumente und Notizen

Markdown-Text ist natürlich in den Formatierungsmöglichkeiten nicht so ausgefeilt, wie etwa Microsoft Word bzw. die Open Source Alternative LibreOffice, reicht aber durchaus für die meisten Ansprüche. Für spezielle Wünsche kann Markdown-Text aber einfach in das entsprechende Format (.docx oder .odt) konvertiert werden. Das "Schweizer Taschenmesser" für diese Umwandlungsroutinen ist pandoc. Pandoc kann in mehr als 60 verschiedene Formate konvertieren.

Besonders erwähnenswert ist es, dass zwar die Mehrheit von Notiz-Programmen Markdown-Text unterstützt, die zwei sehr häufig genutzten Applikationen Evernote und OneNote jedoch (noch?) nicht. Eine Liste von 64 Markdown-Editoren bzw. Markdown-Komponenten findet sich auf https://www.markdownguide.org/tools/. Siehe auch die Liste auf sourceforge.

Vor allem für eine leichte aber doch steile Lernkurve von Markdown-Text möchte ich Dillinger und StackEdit erwähnen. Sie verlangen keine Installation einer eigenen Applikation, sondern können direkt im Browser genutzt werden. Während Sie im linken Feld Ihren Markdown-Text schreiben, sehen Sie rechts die formatierte HTML-Seite. (Auch in Obsidian können Sie sich eine entsprechende Lernumgebung zusammen bauen. Dazu werde ich noch später in einem eigenen Beitrag schreiben, wenn ich den Einsatz von Schreibbereichen (Panes), Fenstern und Reitern🔗 erkläre.)

Auch viele andere Programme nutzen Markdown-Text oder zumindest eine Untermenge davon. Sie können Sie Google Docs so einstellen, dass Markdown erkannt wird. Viele Foren wie StackOverflow, Reddit und Chats wie z.B. What's App und Slack – um nur einige Beispiele zu nennen – nutzen ebenfalls (eine Untermenge) von Markdown Kommandos.

Zum Abschluss für diesen Abschnitt einige verlinkte Beispiele für Applikationen, die Markdown Dokumente erzeugen (aus markdownguide.org.

Mac: MacDown, iA Writer, or Marked 2
iOS / Android: iA Writer
Windows: ghostwriter or Markdown Monster
Linux: ReText or ghostwriter
Web: Dillinger or StackEdit

Die Eigenschaften von Markdown-Text werden von einem Programm der künstlichen Intelligenz durch Notebook, Notizheft und Füllfeder veranschaulicht. — **Illustration 1**: Dieses Bild wurde mit einem Text, der die Vorteile von Markdown beschreibt automatisch mit DALL-E 2 generiert. DALL-E 2 ist ein Programm der künstlichen Intelligenz, das auf der Grundlage von Texteingaben realistische und kunstvolle Bilder generiert. Der genaue Textlaut, der dieses Bild generiert hat: "Portable, device independent, future proof and widespread software for writing especially note-taking".

Bücher

Selbst so komplexe Produkte wie Bücher können mit Markdown-Text erstellt werden. markdownguide.org erwähnt hier LearnPub, Kindle Direct Publishing (kdp) und verweist auf einen Erfahrungsbericht zu einer Publikation mit Markdown.

Ich selbst hatte mit MS Word bessere Ergebnisse als mit kdp und Markdown-Text, als ich für meine Frau Der Rollatormann über Amazon veröffentlichte. Für Datenanalysen und Präsentationen verwende ich selbst seit einigen Jahren das R Paket bookdown. Es erlaubt Cross Media Publishing (CMP) von Büchern in ePub, Mobi, PDF und natürlich Web. Siehe dazu meine tutorielle Artikelserie und die vielen Beispiele auf der bookdown.org Seite.

Markdown Syntax lernen

In einem eigenen Artikel werde ich später auf die Besonderheiten von Markdown-Text in Obsidian eingehen. Hier jedoch werde nur kurz auf die verschiedenen allgemeinen Möglichkeiten der Formatierung von Markdown-Text hinweisen. Es gibt dazu nämlich sehr viele Cheat-Sheets (Schummelzettel), die diese Befehle übersichtlich darstellen. Siehe z.B. die Zusammenstellung der Markdown-Syntax auf markdownguide.org, die auf der Webseite auch auf weitere ausführlichere Information der einzelnen Befehle verlinkt oder auch über den Browser gedruckt oder als PDF heruntergeladen werden kann.

Markdown Cheat Sheet Herunterladen

Oder laden Sie sich die PDF-Übersicht von learn-markdown.github.io herunter.

Auch viele Online-Tutorial laden zum Experimentieren und Lernen dieser einfachen Auszeichnungssprache ein:

Markdown Basis Befehle

Praktisch alle Markdown-Editoren nutzen die von John Gruber in 2014 vorgeschlagenen ursprüngliche Basis-Syntax. Sie können die Resultate der entsprechenden textlichen Markierungen in Dillinger sofort sehen. Links tippen Sie die Markdown Formatierung ein und rechts sehen Sie das Ergebnis.

Für Links verwendet Obsidian Markdown auch die Wiki-Notation: Dabei wird der Dateiname mit zwei eckigen Klammern umschlossen wie z.B. in [[Wiki-Link]].

Markdown Erweiterte Syntax

Um den inzwischen gehobenen Ansprüchen gerecht zu werden, wurde seit der Einführung von Markdown 2014 die Syntax beträchtlich erweitert. Allerdings haben nicht alle Markdown "Dialekte" diese erweiterte Syntax implementiert.

**Bildschirmfoto** 2: Übersicht der erweiterten Markdown Befehle.

Tabellen sind manuell in Markdown etwas mühsam zu erstellen. Obwohl es in Obsidian einen spezielle Erweiterung zum Schreiben von Tabellen gibt, empfehle ich Online-Markdown-Tabellen-Generatoren.
- Tables Generator
- Data Table Editor & Generator

Obsidian Markdown kennt keine Definitionslisten, Tief- und Hochstellung. Für Tief- und Hochstellung kann jedoch HTML-Code genutzt werden wie z.B. H<sub>2</sub>O für H₂0 und X<sup>2</sup> für X².

Drei Spezifika für Obsidian Markdown

Abgesehen davon, dass Links in Obsidian auch mit der kürzeren (und einfacheren) Wiki-Notation gesetzt werden können (zwei eckige Klammern zu Beginn und am Ende des Links) gib es darauf aufbauend noch weitere Besonderheiten in Obsidian.

Obsidian Markdown: Alias

Häufig ist der Dateiname als Link zu einer anderen Seite nicht gut für den laufenden Text geeignet. Deshalb gibt es die Möglichkeit zur selben Seite mit unterschiedlichen Namen zu verlinken. Dabei folgt dem Dateiname ein senkrechter Strich (Taste ALT-7) mit dem anschließenden Text der als Verlinkung erscheinen soll.

Dieser Satz verlinkt zum [[Productivity MOC | Produktivitätskapitel]].

wird in Obsidian folgendermaßen dargestellt:

Dieser Satz verlinkt zum Produktivitätskapitel.

Obsidian Markdown: Inline-Verlinkung

Ich habe schon erwähnt, dass Links in Obsidian auch mit der einfacheren Wiki-Syntax (zwei eckigen Klammern am Beginn und Ende des Links) erstellt werden. Mit dem Hash-Symbol # kann auch direkt zu Überschriften innerhalb der Datei verlinkt werden. Mit dem Zirkomflex (Dachakzent) ^ können auch Blöcke (Absätze) direkt angesteuert werden. Obsidian öffnet bei beiden Varianten ein Menü zur Auswahl, wenn Sie eines der beiden Symbole unmittelbar nach dem normalen Link (=Dateinamen) schreiben.

[[normaler Seitenlink]]

[[Seitenlink#Zur passenden Überschrift]]

[[Seitenlink^zum Absatzblock]]

Obsidian Markdown: Einbindung von Seiten, Textteilen und Dateien

Eine weitere spezielle Eigenschaft von Obsidian ist Transklusion (Transclusion), d.h. die Einbindung von Seiten oder Textdateien. Dazu muss nur zu den oben angeführten Linksbeispielen ein Rufzeichen den beiden öffnenden eckigen Klammern unmittelbar vorgestellt werden.

![[normaler Seitenlink]]

![[Seitenlink#Zur passenden Überschrift]]

![[Seitenlink^zum Absatzblock]]

Statt (Teile) einer anderen Obsidian-Seite zu inkludieren, können auch andere Dateien transkludiert (eingebunden) werden, wie z.B. in ![[dokument.pdf]]

Diese Funktion gilt für folgende Dateitypen:

Markdown files: md;
Image files: png, jpg, jpeg, gif, bmp, svg;
Audio files: mp3, webm, wav, m4a, ogg, 3gp, flac;
Video files: mp4, webm, ogv;
PDF files: pdf.

Die Zukunft von Markdown

Die ursprüngliche Spezifikation von John Gruber aus dem Jahre 2004 ist nicht in allen Fällen eindeutig. Außerdem wurde sie in der Zwischenzeit erweitert (Extended Markdown Syntax). Das hat zu unterschiedlichen "Dialekten" (flavours) von Markdown geführt.

Mit der Initiative von CommonMark wird versucht eine einheitliche kanonische Beschreibung der Markdown Beschreibungssprache zu erreichen. Inwieweit das gelingt ist noch eine offene Angelegenheit. Dass aber die Bedeutung von Markdown (nicht nur) für das Schreiben im Web weiterhin zunehmen wird, steht für mich außer Zweifel.

Warum (Obsidian) Markdown-Text?