Markdown ist eine vereinfachte Auszeichnungssprache, die von John Gruber und Aaron Swartz entworfen und im Dezember 2004 mit Version 1.0.1 spezifiziert wurde. Ein Ziel von Markdown ist, dass schon die Ausgangsform ohne weitere Konvertierung leicht lesbar ist.


Erste Schritte

Eine Übersicht über Markdown, wie es funktioniert, unsd was man damit alles machen kann.


Was ist Markdown?

Markdown ist eine einfache Markup-Sprache, die Sie verwenden können, um Formatierungselemente zu Klartextdokumenten hinzuzufügen. Markdown wurde 2004 von John Gruber gegründet und ist heute eine der beliebtesten Auszeichnungssprachen der Welt.

Die Verwendung von Markdown unterscheidet sich von der Verwendung eines WYSIWYG-Editors. In einer Anwendung wie Microsoft Word klicken Sie auf Schaltflächen, um Wörter und Ausdrücke zu formatieren. Die Änderungen sind sofort sichtbar. Markdown ist nicht so. Wenn Sie eine mit Markdown formattierte Datei erstellen, fügen Sie dem Text Markdown-Syntax hinzu, um anzugeben, welche Wörter und Ausdrücke anders aussehen sollen.

Um beispielsweise eine Überschrift zu kennzeichnen, fügen Sie ein Nummernzeichen vor der Überschrift ein (z. B. # Überschrift Eins). Oder um einen Satz fett zu machen, fügen Sie vor und nach dem Namen zwei Sternchen hinzu (z. B. ** dieser Text ist fett **). Es kann eine Weile dauern, bis Sie sich an die Markdown-Syntax in Ihrem Text gewöhnt haben, insbesondere wenn Sie an WYSIWYG-Anwendungen gewohnt sind. Der folgende Screenshot zeigt eine Markdown-Datei, die im Atom-Texteditor angezeigt wird.

atom markdown screenshot

Sie können Markdown-Formatierungselemente mit einer Texteditoranwendung zu einer Klartext-Datei hinzufügen. Sie können auch eine der zahlreichen Markdown-Anwendungen für Mac OS, Windows, Linux, iOS und Android verwenden. Es gibt auch mehrere webbasierte Anwendungen, die speziell für das Schreiben in Markdown entwickelt wurden.

Abhängig von der verwendeten Anwendung können Sie möglicherweise keine Vorschau des formatiterten Dokuments in Echtzeit anzeigen. Aber das ist OK. Laut Gruber ist die Markdown-Syntax lesbar und unauffällig, so dass der Text in Markdown-Dateien auch gelesen werden kann, wenn er nicht gerendert wird.

Das übergeordnete Designziel für die Formattierungssyntax von Markdown besteht darin, sie so lesbar wie möglich zu machen. Die Idee ist, dass ein Markdown-formattiertes Dokument als reiner Text veröffentlicht werden kann, ohne dass es so aussieht, als wäre es mit Tags oder Formatierungsanweisungen versehen.


Auf Tuchfühlung gehen

Der beste Weg, um mit Markdown zu beginnen, ist die Verwendung von Markdown. Das ist dank zahlreicher kostenloser Tools einfacher als je zuvor.

Sie müssen nicht einmal etwas herunterladen. Es gibt mehrere Online-Markdown-Editoren, mit denen Sie versuchen können, in Markdown zu schreiben. Dillinger ist einer der besten Online-Markdown-Redakteure. Öffnen Sie einfach die Web-Site und tippen Sie etwas im linken Fensterbereich ein. Im rechten Bereich wird eine Vorschau des gerenderten Dokuments angezeigt.

dillinger.io screenshot

Wahrscheinlich möchten Sie die Dillinger-Website beim Lesen dieser Anleitung geöffnet halten. Auf diese Weise können Sie die Syntax ausprobieren, wenn Sie etwas darüber erfahren. Nachdem Sie sich mit Markdown vertraut gemacht haben, möchten Sie möglicherweise eine Markdown-Anwendung verwenden, die auf Ihrem Desktop-Computer oder mobilen Gerät installiert werden kann.

Wie funktioniert es?

Dillinger macht das Schreiben in Markdown einfach, weil es den Hintergrund hinter den Kulissen verbirgt, aber es lohnt sich zu untersuchen, wie der Prozess im Allgemeinen funktioniert.

Wenn Sie in Markdown schreiben, wird der Text in einer Klartextdatei gespeichert, die die Erweiterung .md oder .markdown hat. Aber was dann? Wie wird Ihre Markdown-formatierte Datei in HTML oder ein druckfertiges Dokument konvertiert?

Die kurze Antwort ist, dass Sie eine Markdown-Anwendung benötigen, die die Markdown-Datei verarbeiten kann. Es gibt viele Anwendungen - von einfachen Skripts bis zu Desktop-Anwendungen, die wie Microsoft Word aussehen. Trotz ihrer visuellen Unterschiede machen alle Anwendungen dasselbe. Wie Dillinger konvertieren sie Markdown-formatierten Text in HTML, damit er in Webbrowsern angezeigt werden kann.

Markdown-Anwendungen verwenden einen sogenannten Markdown-Prozessor (häufig auch als "Parser" oder "Implementierung" bezeichnet), um den Markdown-formattierten Text in HTML-Format auszugeben. Zu diesem Zeitpunkt kann Ihr Dokument in einem Webbrowser angezeigt oder mit einem Stylesheet kombiniert und gedruckt werden. Unten sehen Sie eine visuelle Darstellung dieses Prozesses.

markdown-rendering-process.png

Zusammengefasst ist dies ein vierteiliger Prozess:

  • Erstellen Sie eine Markdown-Datei mit einem Texteditor oder einer speziellen Markdown-Anwendung. Die Datei sollte die Erweiterung .md oder .markdown haben.
  • Öffnen Sie die Markdown-Datei in einer Markdown-Anwendung.
  • Verwenden Sie die Markdown-Anwendung, um die Markdown-Datei in ein HTML-Dokument zu konvertieren.
  • Zeigen Sie die HTML-Datei in einem Webbrowser an oder konvertieren Sie sie mit der Markdown-Anwendung in ein anderes Dateiformat, z. B. PDF.

Aus Ihrer Sicht variiert der Prozess je nach verwendeter Anwendung etwas. Zum Beispiel kombiniert Dillinger die Schritte 1 bis 3 in einer einzigen, nahtlosen Benutzeroberfläche. Sie müssen lediglich im linken Bereich tippen, und die gerenderte Ausgabe erscheint magisch im rechten Bereich. Wenn Sie jedoch andere Tools verwenden, beispielsweise einen Texteditor mit einem statischen Website-Generator, werden Sie feststellen, dass der Prozess deutlich sichtbarer ist.


Wofür ist Markdown gut?

Markdown ist eine schnelle und einfache Möglichkeit, Notizen zu machen, Inhalte für eine Website zu erstellen und druckfertige Dokumente zu erstellen.

Das Erlernen der Markdown-Syntax dauert nicht lange. Sobald Sie wissen, wie Sie sie verwenden, können Sie mit Markdown fast überall schreiben. Die meisten Benutzer verwenden Markdown, um Inhalte für das Web zu erstellen. Markdown eignet sich jedoch zum Formatieren von E-Mail-Nachrichten bis hin zu Einkaufslisten.

Hier einige Beispiele, was Sie mit Markdown machen können:

Websites

Markdown wurde für das Web entwickelt, daher sollte es nicht überraschen, dass es viele Anwendungen gibt, die speziell für die Erstellung von Website-Inhalten entwickelt wurden.

Wenn Sie nach einer möglichst einfachen Möglichkeit suchen, eine Website mit Markdown-Dateien zu erstellen, besuchen Sie blot.im und smallvictori.es. Nachdem Sie sich für einen dieser Dienste angemeldet haben, erstellen sie einen Dropbox-Ordner auf Ihrem Computer. Ziehen Sie Ihre Markdown-Dateien einfach in den Ordner und - fetig! - Sie befinden sich auf Ihrer Website. Es könnte nicht einfacher sein.

Wenn Sie mit HTML-, CSS- und Versionskontrolle vertraut sind, besuchen Sie Jekyll, einen beliebten statischen Site-Generator, der Markdown-Dateien verwendet und eine HTML-Website erstellt. Ein Vorteil dieses Ansatzes ist, dass GitHub Pages ein kostenloses Hosting für von Jekyll generierte Websites bietet. Wenn Jekyll nicht Ihr Ding ist, wählen Sie einfach einen der vielen anderen Generatoren für statische Standorte aus.

Wenn Sie ein Content-Management-System (CMS) für Ihre Website verwenden möchten, werfen Sie einen Blick auf Ghost. Es ist eine kostenlose und Open Source-Plattform für Blogging mit einem schönen Markdown-Editor. Wenn Sie ein WordPress-Benutzer sind, werden Sie sich darüber freuen, dass Markdown für Websites unterstützt wird, die auf WordPress.com gehostet werden. Selbst gehostete WordPress-Sites können das Jetpack-Plugin verwenden.

Notizen

In fast jeder Hinsicht ist Markdown die ideale Syntax für Notizen. Leider unterstützen Evernote und OneNote, zwei der beliebtesten Notizenanwendungen, derzeit nicht Markdown. Die gute Nachricht ist, dass mehrere andere Notizanwendungen Markdown unterstützen:

  • Simplenote ist eine kostenlose Barebones-Notizenanwendung, die für jede Plattform verfügbar ist.
  • Bear ist eine Evernote-ähnliche Anwendung, die für Mac- und iOS-Geräte verfügbar ist. Standardmäßig wird nicht ausschließlich die Markdown-Syntax verwendet. Sie können jedoch den Markdown-Kompatibilitätsmodus aktivieren.
  • Boostnote bezeichnet sich selbst als "Open Source Notizen-App für Programmierer".

Wenn Sie sich nicht von Evernote trennen können, besuchen Sie Marxico, einen abonnementbasierten Markdown-Editor für Evernote, oder verwenden Sie Markdown Here mit der Evernote-Website.

Bücher

Möchten Sie einen Roman selbst veröffentlichen? Versuchen Sie es mit Leanpub, einem Dienst, der Ihre mit Markdown formatierten Dateien in ein E-Book umwandelt. Leanpub gibt Ihr Buch im PDF-, EPUB- und MOBI-Dateiformat aus. Wenn Sie Taschenbücher Ihres Buchs erstellen möchten, können Sie die PDF-Datei in einen anderen Dienst wie Kindle Direct Publishing oder CreateSpace hochladen. Um mehr über das Schreiben und Selbstveröffentlichen eines Buches mit Markdown zu erfahren, lesen Sie diesen Blogeintrag.

Präsentationen

Ob Sie es glauben oder nicht, Sie können Präsentationen aus Markdown-Dateien erstellen. Das Erstellen von Präsentationen in Markdown ist etwas gewöhnungsbedürftig, aber sobald Sie sich damit auskennen, ist es viel schneller und einfacher als mit einer Anwendung wie PowerPoint oder Keynote. Remark (GitHub-Projekt) ist ein beliebtes, browserbasiertes Markdown-Slideshow-Tool, ebenso wie Cleaver (GitHub-Projekt). Wenn Sie einen Mac verwenden und eine Anwendung vorziehen, sollten Sie Deckset oder Marked ausprobieren.

Email

Wenn Sie viele E-Mails senden und die Formattierungssteuerelemente der meisten E-Mail-Provider Websites nicht mehr benötigen, können Sie sich darüber freuen, wie Sie mit Markdown E-Mail-Nachrichten auf einfache Weise verfassen können. Markdown Here ist eine kostenlose und Open Source-Browsererweiterung, die Markdown-formatierten Text in HTML konvertiert, das zum Senden bereit ist.

Dokumentation

Markdown ist eine natürliche Voraussetzung für die technische Dokumentation. Unternehmen wie GitHub wechseln zunehmend zu Markdown, um ihre Dokumentation zu erstellen. Lesen Sie in ihrem Blogpost nach, wie sie ihre Markdown-formatierte Dokumentation nach Jekyll migriert haben. Wenn Sie eine Dokumentation für ein Produkt oder eine Dienstleistung schreiben, werfen Sie einen Blick auf diese praktischen Tools:

  • Read the Docs kann aus Ihren Open-Source-Markdown-Dateien eine Dokumentations-Website erstellen. Verbinden Sie einfach Ihr GitHub-Repository mit ihrem Dienst und drücken Sie - Read the Docs erledigt den Rest. Sie haben auch einen Service für gewerbliche Einrichtungen.
  • MkDocs ist ein schneller und einfacher statischer Seitengenerator, der auf die Dokumentation von Projekten ausgerichtet ist. Dokumentationsquelldateien werden in Markdown geschrieben und mit einer einzigen YAML-Konfigurationsdatei konfiguriert. MkDocs verfügt über mehrere integrierte Themen, darunter einen Port der Read the Docs Dokumentation für die Verwendung mit MkDocs. Eines der neuesten Themen ist MkDocs Material.
  • Docusaurus ist ein statischer Site-Generator, der ausschließlich zum Erstellen von Dokumentations-Websites entwickelt wurde. Es unterstützt Übersetzungen, Suche und Versionierung.
  • VuePress ist ein statischer Standortgenerator, der von Vue angetrieben wird und für das Erstellen technischer Dokumentation optimiert ist.
  • Jekyll wurde zuvor im Abschnitt über Websites erwähnt, ist aber auch eine gute Option zum Erstellen einer Dokumentations-Website aus Markdown-Dateien. Wenn Sie diese Route wählen, sollten Sie unbedingt das Jekyll-Dokumentationsthema ansehen.

Zusätzliche Ressourcen

Es gibt viele Ressourcen, mit denen Sie Markdown lernen können. Hier sind einige andere einführende Ressourcen:


Möchten Sie mehr über Markdown erfahren?

Dieses Dokument wurde in Markdown verfasst. Ich verwende Markdown schon seit einigen Jahren und verwende es unter anderem zum Schreiben von E-Mails und für die Programm-Dokumentation, aber auch wie hier um Markdown-Dokumente in einen WordPress - Blogbeitrag einzufügen.

Schreiben sie mir über das Kontaktformular.

Lesen Sie mehr und ausführlich über Markdown hier :

https://www.markdownguide.org/

screenshot of https://www.markdownguide.org/


Quelle:
https://www.markdownguide.org/getting-started