senäh

17senäh und so…

Markdown - kurze Vorstellung und meine Verwendung dafür

HTML/CSS/JS, PHP, Server & Config, WordPress
20. Nov 2011
Kommentare: 1

Markdown – kurze Vorstellung und meine Verwendung dafür

Kategorien: HTML/CSS/JS, PHP, Server & Config, WordPress | 20. Nov 2011 | Kommentare: 1

Markdown, der ein oder andere mag bereits davon gehört haben. Ich erst vor so ca. 1-2 Monaten. In diesem Post will ich einerseits auf die Existenz von Markdown hinweisen, euch darlegen, wofür ich es verwende aber auch aufzeigen, wo ich die Grenzen sehe.

Markdown? Wrestling-Move oder was?

Für alle diejenigen, die mit dem Begriff nichts anfangen können, hier mal die obligatorische Einführung. Markdown stammt im Ursprung von John Gruber und geht wohl auf das Jahr 2004 zurück. Wie man sieht bin ich mit meiner jetzigen Entdeckung mal wieder auf der Höhe der Zeit :D

Markdown meint dabei eine einfach gehaltene Syntax für Schreiberlinge und vor allem Webentwickler, um Content auf eine möglichst menschen-lesbare Art und Weise zu strukturieren. Quasi HTML ohne Tags. Das ganze funktioniert denkbar einfach, ist aber auch entsprechend limitiert. Hier mal nen Beispiel-Text:

# Überschriften werden durch Rauten erzeugt

## Je mehr Rauten, desto geringer die Ordnung

Normale Textabschnitte schreibt man weiterhin wie gewohnt.
Will man bestimmte Worte oder Wortgruppen besonders
hervorheben, kann man entweder **Fettdruck** verwenden
oder *Kursivschrift*. Für __beides__ davon gibt es auch
jeweils eine _alternative_ Syntax.

Alternativen
============

... gibt es übrigens auch für die Syntax der Überschriften
----------------------------------------------------------

Für Listen gibt es ebenfalls mehrere Möglichkeiten:
- der klassische Bindestrich ist eine Wahl
* ebenso das Sternchen

Ein paar weitere Feinheiten gibt es noch. Wer sich für eine komplette Liste interessiert, schaut sich entweder den passenden Wikipedia-Eintrag an oder bedient sich direkt beim Ursprung.

Wozu brauch ich sowas?

Hm. Gute Frage. Vielleicht gar nicht. Ich kann euch nur sagen, warum ich es für mich entdeckt habe und in welchen Situationen ich darauf zurückgreife.

Eigentlich kommt jede Anwendung in Frage, bei der es darum geht Informationen auf eine möglichst “sparsame” Art und Weise zu strukturieren. Was meine ich damit? Sobald man Informationen in Textform festhalten möchte, neigt man aus Gewohnheit dazu ein Textprogramm wie Word zu öffnen. Das kann für gewöhnlich dauern. Und selbst wenn nicht: ist es nicht unnötig für die einfache Notation von Texten ein derart aufgeblähtes Programm zu bemühen? Meist ja. Es geht uns ja nicht um die gestalterisch wertvolle Darstellung von Informationen, sondern lediglich um das Erfassen der Struktur.

Word bietet für das einfache Strukturieren zwar das praktische Mittel der Formatvorlagen. Allerdings ist wie gesagt das ganze Programm an sich für die Anwendungsfälle, auf die ich abziele, viel zu overdozed.

Unterschied in der Dateigröße – Word- vs. Textdatei

Unterschied in der Dateigröße – Word- vs. Textdatei

Beispiel 1: Dokumentation (nein, nicht das mit dem Discovery Channel)

Der Anwendungsfall Nummer 1 für mich ist: Dokumentation unter Entwicklern. Eine Textdatei, die dem Austausch zwischen Programmierern dient. Einer von beiden hat etwas programmiert und das hoffentlich sauber dokumentiert, ein anderer soll daran weiterarbeiten und bekommt für den leichteren Einstieg besagtes Dokument vorgebatscht. Sollten hierbei die normalen Kommentare im Quelltext nicht ausreichen, kann man als Dokumentationsschreibender schnell eine neue Textdatei anlegen und die restlichen, hoffentlich hilfreichen Kommentare dort hinein packen. Wie gesagt: eine Word-Datei ist dafür übertrieben. Und Programmierer lieben es ja bekanntlich eh unhübsch, d.h. in plain-text ;)

Schnell beobachtet man hierbei jedoch proprietäre – also vom jeweiligen Programmierer mehr oder weniger “erfundene” – Strukturen vor. Einer Überschrift folgen stets 2 Leerzeilen. Hinter jedem Satz ein neuer Absatz, einzelne Abschnitte werden durch 3 Bindestriche getrennt, etc.

Struktur von Dokumenten ist hilfreich für den Lesenden. Allerdings – der geneigte Webentwickler weiß das – ist im Zweifelsfall immer ein Standard vorzuziehen. Hier kommt Markdown ins Spiel. So einfach.

Die Kommentare werden entsprechend der Markdown-Syntax notiert. Dadurch entsteht schon ein recht guter Überblick über das Gesamtdokument. Entsprechende Interpreter können bei Bedarf aus dem Dokument eine besser lesbare Form generieren, in der Überschriften, Listen und Auszeichnungen (fett, kursiv) entsprechend formatiert sind. Ich verwende übrigens den noch in der Beta-Phase befindlichen und daher kostenlosen Markdown-Editor Mou.

Markdown-Split-View in Mou

Markdown-Split-View in Mou

Anwendungsfall Nummer 2: Notizen für To-Dos

Ich bin ein großer Fan von To-Do-Listen und verwende selbst das von mir ernannte Getting-Things-Done-Flagschiff Things.

Einzelne To-Dos sollte man sinnvollerweise recht kurz betiteln, damit sie beim Überfliegen der anstehenden Aufgaben schnell und komplett erfassbar sind. Bedarf es weiterer Ausführungen, hat man unter Things die Möglichkeit Notizen einzufügen. Auch hier hat man allerdings wieder das Problem, dass mit zunehmender Informationsfülle eine Strukturierung nötig ist. Abhilfe schafft – der aufmerksame Blogleser wird es sich denken können – Markdown.

Strukturierte Notizen in Things

Strukturierte Notizen in Things

Anwendungsfall Nummer 3 (wenn auch nicht für mich): bloggen

Es gibt Leute, die notieren ganze Blogposts und Websites in Markdown. Genau genommen wurde Markdown ja auch genau für diesen Zweck erschaffen: einfaches Konvertieren von Plain Text nach HTML. Prinzipiell durchaus denkbar, jedoch geht hier das Handling von Bildern und Links nur schwer mit meinem Workflow konform. Ich erstelle Bilder meist erst während des Schreibens und lade sie auch dann erst hoch. Außerdem generiert mir WordPress immernoch einen caption-Shortcode für die Bildbetitelung.

Problem mit Bildern in MarsEdit

Problem mit Bildern in MarsEdit

Entsprechend bietet mir durch diesen Umstand ein eigentlich cleveres Tool wie MarsEdit in Verbindung mit Markdown keinen Vorteil gegenüber dem normalen RTE im WordPress-Backend.

Fazit

Tatsächlich bin ich froh drüber, dass ich die Entdeckung gemacht habe und nun produktiv mit Markdown arbeite. Jedoch ist das sicher nicht jedermanns Sache bzw. sieht nicht jeder den großen Gewinn darin. Das ist gut und richtig so, jeder so wie er kann.

Wer sich aber in den von mir beschriebenen Problemen wiederfindet, sollte mal probieren, ob er die Markdown-Syntax nicht auch irgendwo sinnvoll einsetzen kann.

Weiterführende Links

  • Einführung in Markdown bei Mac-AppStorm.
  • Etwas ähnliches auf Deutsch drüben bei apfelquak.
  • Vorstellung eines Markdown-Editors für Windows bei golem.
  • Vorstellung des zur Zeit von mir verwendeten Markdown-Editors Mou bei Mac-AppStorm.

Autor: Enno

Ich bin Enno. PHP ist mein Ding, aber auch alles Neue rund um die Themen HTML5, CSS3 & Co finde ich interessant. Ich mag es Leuten zu helfen und mein Wissen weiterzugeben. Sollte dir mein Beitrag gefallen haben, lass doch nen Kommentar da oder benutze einen der Social Buttons, um deinen Dank auszudrücken ;)

Kommentare (1)

  1. Coole Sache. Kannte ich so bisher noch nicht. Das Problem, dass jeder Entwickler eine eigene Kommentar-Formatierung nutzt, kenne ich =/

    Und schön bebildert der ganze Artikel :D 

Hinterlasse einen Kommentarsenäh

Pflichtfelder sind mit * markiert.