Markdown

aus Wikipedia, der freien Enzyklopädie
Wechseln zu: Navigation, Suche

Vorlage:Infobox Dateiformat/Wartung/MagischeZahl fehltVorlage:Infobox Dateiformat/Wartung/Standard fehlt

Markdown
Markdown-mark.svg
Dateiendung: .md, .markdown
MIME-Type: text/x-markdown
Entwickelt von: John Gruber
Art: Vereinfachte Auszeichnungssprache
Website: daringfireball.net/projects/markdown

Markdown ist eine vereinfachte Auszeichnungssprache, die von John Gruber und Aaron Swartz entworfen und Dezember 2004 mit Version 1.0.1 spezifiziert wurde. Ein Ziel von Markdown ist, dass schon die Ausgangsform ohne weitere Konvertierung leicht lesbar ist. Als Auszeichnungselemente wurden daher vor allem Auszeichnungsarten verwendet, die in Plaintext und E-Mails üblich sind. Auch andere Auszeichnungssprachen mit ähnlichen Zielen zur Lesbarkeit – wie reStructuredText oder Textile – hatten Einfluss auf die Syntax.

Die Markdown-Konvertierungssoftware wandelt Text in gültiges und W3C-konformes XHTML um. Die Referenzimplementierung in Perl steht unter einer BSD-artigen Lizenz. Weiter sind inzwischen Implementierungen in den gängigsten Programmiersprachen wie C (z. B.[1]), PHP (z. B. [2]), Python (z. B. [3]), Go (z. B. [4]) oder JavaScript (z. B. [5]) verfügbar.

Genutzt wird Markdown auf Plattformen mit eher technisch affinen Publikum wie GitHub, Stack Overflow oder der Blogging-Plattform Ghost. Google+ verwendet zum Auszeichnen von kursivem, fettem und durchgestrichenem Text eine Syntax, welche Markdown ähnelt und oft irrtümlich mit Markdown assoziiert wird. Die Syntax ist aber die von Textile. [6]

Die meisten größeren Content-Management-Systemen, Wikis und Foren können per Plugin auf Markdown nachgerüstet werden. Es gibt Plugins für Wordpress[7], Joomla [8] oder Mediawiki[9]. Markdown wird auch in anderer Software genutzt, z.B. im Software-Dokumentationswerkzeug Doxygen.

Auszeichnungsbeispiele[Bearbeiten]

Für die Auszeichnung von Text verwendet Markdown vor allem Satzzeichen und gestattet in einigen Fällen mehrere gleichwertige Methoden. Zeichen, die für gewöhnlich als Formatbefehle verstanden werden, können mit einem umgekehrten Schrägstrich (Backslash) maskiert (übergangen) werden. So wird beispielsweise ein Sternsymbol („Asterisk“, „*“) am Zeilenbeginn als Aufzählungszeichen interpretiert; will man wirklich ein Sternchen, leitet man es mit einem Backslash ein: „\*“.

Autoren können bei Bedarf für komplexere Auszeichnungen XHTML-Blockelemente verwenden. Diese Elemente werden von der Konvertierungssoftware ohne Änderung in das Zieldokument übernommen. Dadurch ist es möglich, Bereiche des Dokuments in gewöhnlichem XHTML zu formatieren.

Textgestaltung
Ausgangsform Zielform
Normaler Text wird so dargestellt wie eingegeben.


Eine Leerzeile erzeugt einen Absatz.

Normaler Text wird so dargestellt wie eingegeben.

Eine Leerzeile erzeugt einen Absatz.

Zwei oder mehr Leerzeichen am Ende der Zeile  

erzeugen einen Zeilenumbruch.

Zwei oder mehr Leerzeichen am Ende der Zeile

erzeugen einen Zeilenumbruch.

*Kursiv*, **Fett** und ***Fett kursiv*** bzw.
_Kursiv_, __Fett__ und ___Fett kursiv___
Kursiv, Fett und Fett kursiv bzw.
Kursiv, Fett und Fett kursiv
Markiert Text als `Quelltext` Markiert Text als Quelltext
* Ein Punkt in einer ungeordneten Liste

* Ein weiterer Punkt in einer ungeordneten Liste
    * Ein Unterpunkt, um vier Leerzeichen eingerückt
* Statt * funktionieren auch + oder -

  • Ein Punkt in einer ungeordneten Liste
  • Ein weiterer Punkt in einer ungeordneten Liste
    • Ein Unterpunkt, um vier Leerzeichen eingerückt
  • Statt * funktionieren auch + oder -
1. Ein Punkt in einer geordneten Liste

2. Ein weiterer Punkt, wobei keine Reihenfolge zu beachten ist, sondern nur beliebige und auch doppelte Ziffern
3. weiterer Punkt

  1. Ein Punkt in einer geordneten Liste
  2. Ein weiterer Punkt, wobei keine Reihenfolge zu beachten ist, sondern nur beliebig und auch doppelte Ziffern
  3. weiterer Punkt
HTML-Überschriften werden erzeugt, indem man die Zeile mit Doppelkreuzen beginnt – ihre Anzahl gibt die Ebene der gewünschten Überschrift an.
# Überschrift in Ebene 1

#### Überschrift in Ebene 4

Überschrift in Ebene 1
Überschrift in Ebene 4
Für die ersten zwei Ebenen ist auch eine alternative Schreibweise möglich:
Überschrift in Ebene 1

======================
Überschrift in Ebene 2
----------------------

Überschrift in Ebene 1
Überschrift in Ebene 2
> Dieses Zitat wird in ein HTML-Blockquote-Element gepackt.

Dieses Zitat wird in ein HTML-Blockquote-Element gepackt.

[Beschriftung des Hyperlinks](http://de.wikipedia.org/ "Titel, der beim Überfahren mit der Maus angezeigt wird") Beschriftung des Hyperlinks
![Alternativtext](Bild-URL "Bildtitel hier") Bindet ein Bild von der Quelle Bild-URL ein.

Weiterentwicklungen[Bearbeiten]

Es gibt mehrere Erweiterungen und Weiterentwicklungen von Markdown, die die eingeschränkten Möglichkeiten erweitern.

Im Oktober 2012 wurde eine Standardisierung von Markdown angeregt.[10]

MultiMarkdown (MMD)
ermöglicht zusätzlich den Export nach LaTeX, PDF und erweitert die Syntax um Fußnoten, Tabellen, Glossare, Zitate, Metadaten (wie Titel, Autor, Datum) und Inline-HTML[11][12].
Markdown Extra
bietet vor allem Inline-HTML und wiederum Markdown innerhalb von HTML Blöcken, Tabellen, Definitionslisten, Abkürzungen, Fußnoten, Sprungmarken für Überschriften.[13]
Pandoc Markdown
ermöglicht das Überführen von Markdown in einige andere Formate, inklusive LaTeX und PDF. Außerdem erweitert es Markdown um Syntax für einfache und gerasterte Tabellen, Definitionslisten, automatische Referenzen für Beispiele, Sprungmarken für Überschriften, automatische Titelseiten, durchgestrichenen Text, Hoch- und Tief-Stellung, Mathematikmodus für alle Ausgabeformate, eingebettetes TeX, Bildunterschriften, Fußnoten und Quellenangaben mit Bibliographie nach CSL.[14]
GitHub Flavored Markdown
ermöglicht das Rendern zu HTML direkt auf dem Webdienst GitHub. Es erweitert die Syntax um Code-Blöcke und Referenzen auf Benutzerprofile, Changesets und Tickets.[15]
Stack Overflow Flavored Markdown
wird auf Stack Overflow verwendet und erweitert die Syntax um Tags, Spoilers und Syntax Highlighting für Code[16]. Es existiert eine Open-Source-Implementierung namens MarkdownSharp[17].

Siehe auch[Bearbeiten]

Quellen[Bearbeiten]

  1. Vicent Martí: Sundown. Am 29. November 2012 als hinfällig bezeichnet. Abgerufen am 16. Juni 2013 (englisch).
  2. Michel Fortin: PHP Markdown. Version 1.3 vom 11. April 2013. Abgerufen am 16. Juni 2013 (englisch).
  3. Python Software Foundation: Markdown. Version 2.3.1 vom 22. März 2013. Abgerufen am 16. Juni 2013 (englisch).
  4. Simon Waldherr: micromarkdown.go. Version 0.1.0 vom 17. Februar 2014. Abgerufen am 22. Februar 2014 (englisch).
  5. John Fraser, Corey Innis, u.a.: Showdown.. Version 0.3.1 vom 2. November 2012. Abgerufen am 16. Juni 2013 (englisch).
  6. Google Inc.: Inhalte auf Google+ teilen - Tipps zum Posten. 2. Mai 2013, abgerufen am 16. Juni 2013.
  7. http://wordpress.org/plugins/markdown-on-save/
  8. http://extensions.joomla.org/extensions/edition/editors/24297
  9. https://www.mediawiki.org/wiki/Extension:MarkdownExtraParser
  10. Jeff Atwood: The Future of Markdown. Coding Horror: Programming and Human Factors. 25. Oktober 2012, abgerufen am 16. Juni 2013 (englisch).
  11. Fletcher Penney: MultiMarkdown. Version 4.1.1 vom 2. Juni 2013. Abgerufen am 16. Juni 2013 (englisch).
  12. Fletcher Penney u.a.: MultiMarkdown Syntax Guide. 25. Dezember 2012, abgerufen am 16. Mai 2013 (englisch).
  13. Michel Fortin: PHP Markdown Extra. Abgerufen am 16. Juni 2013 (englisch).
  14. John MacFarlane: Pandoc User’s Guide. Abgerufen am 16. Juni 2013 (englisch).
  15. GitHub Inc.: GitHub Flavored Markdown. 14. Juni 2013, abgerufen am 13. Juni 2013 (englisch).
  16. Stack Exchange Inc.: Markdown help. Abgerufen am 16. Juni 2013 (englisch).
  17. Jeff Atwood: MarkdownSharp. C# Markdown processor. Version 113 vom 3. Juli 2010. Abgerufen am 16. Juni 2013 (englisch).

Weblinks[Bearbeiten]