Markdown Die Ins und Outs

Markdown ist eine erschreckend einfache Auszeichnungssprache, mit der Sie schreiben können, indem Sie ein einfach lesbares, einfach zu schreibendes Klartextformat verwenden. Dieses Format kann dann in Sekunden in eine andere Auszeichnungssprache wie HTML konvertiert werden!

Wenn Sie damit nicht vertraut sind, lassen Sie mich es Ihnen heute beibringen!

Markdown macht einen fantastischen Job, um aus dem Weg zu gehen.

Markdown macht einen fantastischen Job, um aus dem Weg zu gehen. Ich bin sicher, jeder hat irgendwann Text in einem Nur-Text-Dokument hervorgehoben, indem er die Phrase mit einem Sternchen * umrandet hat. Genau so funktioniert es in Markdown! Zusätzliche Betonung (ein Wort) ist so einfach wie das Verdoppeln des Sterns **..

Es ist keine Überraschung, dass Markdowns Philosophie darin besteht, Inhalte zu produzieren, die "so wie sie sind veröffentlicht werden können, ohne auszusehen, als wären sie mit Markierungen versehen worden".

Die Vorteile sollten für jeden offensichtlich sein, der versucht, webbasierte Inhalte zu schreiben, und sich auch Gedanken über die Formatierung machen musste. Text hier Es ist einfach zu schwer zu tippen, sobald sich das Gehirn im Fluss befindet - ganz zu schweigen davon, wie die Hektik von HTML-Tags, die ein Dokument plagen, die Lesbarkeit beeinträchtigen kann, während Sie ein Dokument prüfen.

Es gibt eine Reihe von Markdown-Editoren, sowohl web- als auch desktopbasiert. Sie können natürlich jeden alten Texteditor verwenden. Der einzige Vorteil, den bestimmte Markdown-Editoren bieten, ist eine Live-Vorschau des generierten HTML-Codes und normalerweise eine gewisse Ebene der Syntaxhervorhebung.

Wenn Sie die folgenden Beispiele ausprobieren möchten, beziehen Sie sich auf den offiziellen, browserbasierten Dingus-Konverter.


Der Markup

Absätze

Mit Markdown wird Text automatisch in Absätze umgewandelt, in denen Textblöcke durch eine Leerzeile getrennt werden. Und nicht nur von mehreren
Tags wie WYSIWYGs vergangener Tage, aber wirklich semantisch

Absätze. Es ist fast wie schwarze Magie.

 Lorem ipsum dolor sitzen amet, consectetur adipisicing elit, sed do eiusmod temporary incididunt ut labore und dolore magna aliqua. Ut enim ad minim veniy, quis nostrud ausüben ullamco laboris nisi ut aliquip ex a commodo follat. Duis auture irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat nicht proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Wird einfach:

Lorem ipsum dolor sitzen amet, consectetur adipisicing elit, sed do eiusmod temporary incididunt ut labore und dolore magna aliqua. Ut enim ad minim veniy, quis nostrud ausüben ullamco laboris nisi ut aliquip ex a commodo follat.

Duis auture irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat nicht proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Eine kleine Kuriosität bei Markdown ist die Behandlung einzelner Zeilenumbrüche. Die Markdown-Philosophie ist, dass der Browser Zeilenumbrüche und keine anderen Personen behandeln sollte. Also der folgende Text:

Lorem ipsum dolor sitzt amet, consectetur. Adipisicing elit, sed do eiusmod tempor incididunt.

Wird ziemlich abscheulich:

Lorem ipsum dolor sitzt amet, consectetur. Adipisicing elit, sed do eiusmod tempor incididunt.

Wenn Sie absolut Muss Fügen Sie einen Zeilenumbruch ein, um dieses Problem zu umgehen: Fügen Sie einfach zwei Leerzeichen am Ende der vorherigen Zeile ein:

Lorem ipsum dolor sitzt amet, consectetur. Adipisicing elit, sed do eiusmod tempor incididunt.

Eine Reihe von Markdown-Flavours kann Zeilenumbrüche auf eine Weise behandeln, die Sie erwarten würden, aber dazu später mehr.

Überschriften

Beginnen Sie einen Absatz mit einem #, und dieser Absatz wird zur Kopfzeile. Die Anzahl von # bezeichnet die Nummer der Überschriftenebene (

,

usw.)

# Überschrift Eins Dies ist ein Absatz. Lorem ipsum dolor sitzen amet, consectetur adipisicing elit, sed do eiusmod temporary incididunt ut labore und dolore magna aliqua. Ut en ad ad minim veniam. ## Überschrift Zwei Dies ist ein Absatz. Lorem ipsum dolor sitzen amet, consectetur adipisicing elit, sed do eiusmod temporary incididunt ut labore und dolore magna aliqua. Ut en ad ad minim veniam. ### Überschrift drei #### Überschrift vier ##### Überschrift fünf ###### Überschrift sechs

Wird:

Überschrift eins

Dies ist ein Absatz. Lorem ipsum dolor sitzen amet, consectetur adipisicing elit, sed do eiusmod temporary incididunt ut labore und dolore magna aliqua. Ut en ad ad minim veniam.

Überschrift zwei

Dies ist ein Absatz. Lorem ipsum dolor sitzen amet, consectetur adipisicing elit, sed do eiusmod temporary incididunt ut labore und dolore magna aliqua. Ut en ad ad minim veniam.

Überschrift Drei

Überschrift vier

Überschrift Fünf
Überschrift Sechs

Eine alternative Syntax ist ebenfalls vorgesehen

und

, wie so:

Überschrift Eins ============ Dies ist ein Absatz. Lorem ipsum dolor sitzen amet, consectetur adipisicing elit, sed do eiusmod temporary incididunt ut labore und dolore magna aliqua. Ut en ad ad minim veniam. Überschrift Zwei ----------- Dies ist ein Absatz. Lorem ipsum dolor sitzen amet, consectetur adipisicing elit, sed do eiusmod temporary incididunt ut labore und dolore magna aliqua. Ut en ad ad minim veniam.

Block Zitate

Ein wichtiger Einfluss von Markdown ist das Senden von E-Mails im Nur-Text-Format. Dies ist offensichtlich, wenn Sie sehen, dass Block-Quotes formatiert sind genau wie in der E-Mail: vorangestellt mit einem >:

Dies ist ein normaler Absatz. > Dies ist ein Blockquote-Absatz. > Und die Blockquote geht auch hier weiter.

… Was konvertiert in:

Dies ist ein normaler Absatz.

Dies ist ein Blockquote-Absatz.

Und die Blockquote geht auch hier weiter.

Code

Mit dem können Sie kleine Inline-Codeausschnitte entfernen ' Zeichen um den Code.

Größere Codeblöcke können durch einfaches Einrücken des Codes um eine Ebene (mindestens ein Tabulator / vier Leerzeichen) definiert werden. Die Einrückungsebene wird entfernt. Markdown entgeht automatisch alle Sonderzeichen innerhalb eines Codeblocks. Dies bedeutet, dass Sie einfach Codeblöcke kopieren können, ohne manuell zu umgehen < zu < und > zu > usw.

Dies ist ein Absatz mit ein bisschen "CODE' drin.  Ein weiterer Absatz, aber mit einem Code-Block darüber.


Dies ist ein Absatz mit ein bisschen "CODE' drin.

 

Ein weiterer Absatz, aber mit einem Code-Block darüber.

Listen

Ein weiteres wahres Beispiel dafür, wie Markdown natürlich kommt, ist die Angabe einer Liste. Beginnen Sie einfach einen Absatz mit einem * (oder +, -), um eine ungeordnete Liste zu erstellen. Verwenden Sie Zahlen, 1., 2. etc. für geordnete Listen:

Ich brauche: * Schlangen * Skorpione * Hamster Dann kann ich mit dem Plan beginnen, die Welt zu regieren: 1. Aquire Hamster 2. Schlangen trainieren, um Hamster zu reiten 3. Die Welt regieren


Ich werde benötigen:

  • Schlangen
  • Skorpione
  • Hamster

Dann kann ich meinen Plan beginnen, die Welt zu regieren:

  1. Hamster kaufen
  2. Trainiere Schlangen, um Hamster zu reiten
  3. Die Welt regieren

Inline-Textelemente

Wir haben bereits zu Beginn dieses Artikels kursive und fette Schrift behandelt (* und **), Sie können jedoch auch die Sternchen gegen Unterstriche tauschen, wenn dies mehr Ihr Ding ist:

Hier ist ein * kursiver * Text und mehr _italic_ Text. Einige ** kühne Sachen ** hier; plus ein wenig mehr.

Verknüpfungen sind in Markdown nett und einfach (wenn Sie sich an den Speicher festlegen können, ob die eckigen und runden Klammern zuerst stehen ...):

[Google] (http://google.com)
Google

Um ein Bild anzuzeigen, voranstellen Sie den Link-Code mit einem !:

![Das Google-Logo] (images_23 / markdown-the-ins-and-outs.png)
Das Google-Logo

Markdown stört Sie nicht

Markdown ist sehr nachsichtig, wenn es darum geht, die Markierung zu verlassen und nur HTML zu verwenden. Wenn Sie eine Tabelle einschließen müssen, fügen Sie sie in HTML ein. Wenn Sie Ihre Links lieber im HTML-Format schreiben möchten, können Sie dies auch tun. Markdown ist intelligent genug, um zu wissen, wann Sie HTML einbeziehen wollen, und es funktioniert um es herum.

Beim Markieren werden auch Zeichen, wie &, < and > in das HTML-Entitätsformular. Sogar gängige Zeichenkombinationen werden auf intelligente Weise in das umgewandelt, was Sie wirklich meinen.

  • Drei Punkte werden automatisch zu einer Ellipse:…
  • Zwei Bindestriche werden zu einem Bindestrich: --
  • Anführungszeichen werden die "fancy", gelockten Versionen von sich selbst.

Flavors & GitHub Flavored Markdown

Es gibt eine Reihe alternativer Markdown-Varianten, die den Standardsatz von Markdown-Regeln erweitern. Eine übliche Erweiterung ist wie oben beschrieben ein einfaches Zeilenumbruch. Eine der bekanntesten Markdown-Varianten ist GitHub's Flavored Markdown. Dies wird verwendet, um Benutzereingaben überall auf ihrer Site zu kennzeichnen. Neben einer verbesserten Zeilenumbruchunterstützung und einer Reihe von GitHub-spezifischen Anpassungen ist meine Lieblingsfunktion ihre Alternative zum Code Fencing, mit der Sie auch eine Syntax für das Hervorheben festlegen können. Umgeben Sie einfach einen Codeblock mit " auf beiden Seiten, einschließlich der Sprache am Anfang, wie folgt:

"php "

Umwandlung

Den Tuts + Markdown-Konverter finden Sie hier.

Der offizielle Konverter ist in Perl geschrieben und steht auf der Markdown-Homepage von Daring Fireball zum Download zur Verfügung. Es gibt auch mehrere andere Markdown-Konverter für eine Vielzahl verschiedener Sprachen - von C… über Ruby… über JavaScript… bis PHP. Eine vollständige Liste der Implementierungen finden Sie in Wikipedia.

Eine beliebte Ruby-Implementierung ist RedCarpet, die auf der C-Bibliothek Sundown basiert. Sie bietet eine sehr einfache Möglichkeit, die Ausgabe des generierten HTML-Codes so anzupassen, dass Ihr eigener "Geschmack" von Markdown erzeugt wird.

Vor kurzem habe ich diese Bibliothek verwendet, um einen Markdown-Konverter zu erstellen, der GitHub Flavored Markdown akzeptiert (um die Angabe einer Codesprache für die Syntaxhervorhebung zu ermöglichen) und den konvertierten HTML-Code in dem für die Tuts + -Sites erforderlichen spezifischen Stil ausgibt. Den Tuts + Markdown-Konverter finden Sie hier. Wenn Sie jemals ein Tutorial für diese Site geschrieben haben, verwenden Sie es auf jeden Fall!

Tatsächlich wurde dieser Artikel in Markdown geschrieben, wobei der beliebte Mou Markdown-Editor für OSX verwendet wurde.