Einführung in Markdown

Einführung in Markdown

Markdown

Markdown ist ein Text zum HTML -Conversion -Tool. Heute ist es das De-facto-Synonym für eine Klasse von leichten Markup-Beschreibungssprachen geworden. Es verwendet eine einfache Textformatierungssyntax. Die Idee hinter dem Markdown bestand darin, Webseiten und insbesondere Blogeinträge so einfach wie das Schreiben einer E-Mail zu machen. Zum Zeitpunkt November 2017 wird das Ziel erreicht und die Ableitungen Asciidoc, Asciidoctor und Asciidoctor-PDF werden in großem Umfang verwendet.

Markdown konzentriert. Es ist leicht zu lernen, da es einfach gehalten wird, daher auch schneller als minimale Zeichen, was zu weniger Chancen eines Fehlers am Ende führt. In Abbildung 1 finden Sie ein grundlegendes Dokument, das im Markdown -Editor Stackedit gezeigt ist. Auf der linken Seite sehen Sie den Quellcode und auf der rechten Seite die entsprechende HTML -Ausgabe. Sie können feststellen, dass die Schlagzeilen einfach mit einer Reihe von #gemäß der Hierarchieebene der Überschrift markiert sind.

Textkonvertierung

Der einfache Text ist mit XHTML (HTML) und vielen anderen Formaten mit den Befehlszeilen -Tools wie Markdown oder Pandoc konvertierbar. Grundsätzlich erstellen beide Tools nur HTML -Fragmente und schreiben die Ausgabe an stdout. Pandoc bietet den Switch "-O Dateinamen", um die HTML-Ausgabe in die angegebene Datei zu schreiben. Wie unten zu sehen ist die Ausgabedatei wird als Basic bezeichnet.HTML und enthält das HTML -Fragment - zwei Schlagzeilen und einen Absatz.

$ pandoc -o grundlegend.HTML Basic.md
$ Cat Basic.html

Debian -Paket -Kreation Howto


Vorwort


Für eine Maschine verantwortlich zu sein bedeutet, die Hardware sowie die Softwarekomponenten zu betreuen. Wie im Alltag als Systemadministrator zu sehen ist, ist es viel besser, Software als Softwarepaket zu installieren als eine Reihe von Quelldateien. Dies senkt die Kosten, um das System ordnungsgemäß aufrechtzuerhalten.
$

So erstellen Sie eigenständige HTML-Dokumente mit einem vollständigen HTML-Header Pandoc akzeptiert den Schalter „-s“ wie folgt:

$ pandoc -o grundlegend.html -s grundlegend.md
$ Cat Basic.html










Debian -Paket -Kreation Howto


Vorwort


Für eine Maschine verantwortlich zu sein bedeutet, die Hardware sowie die Softwarekomponenten zu betreuen. Wie im Alltag als Systemadministrator zu sehen ist, ist es viel besser, Software als Softwarepaket zu installieren als eine Reihe von Quelldateien. Dies senkt die Kosten, um das System ordnungsgemäß aufrechtzuerhalten.

Der Vorteil, den Inhalt von Ihrer visuellen Anzeige getrennt zu halten, besteht darin, dass er das Aussehen Ihrer Website nicht durcheinander bringt. Version 1.0.1, das von John Gruber und Aaron Swartz entwickelt wurde, wurde im Dezember 2004 veröffentlicht und ist als kostenlose Software erhältlich (siehe Links am Ende dieses Artikels).

Textelemente

Schlagzeilen

Gemäß der entsprechenden HTML -Ebene werden Schlagzeilen mit einer Reihe von #wie folgt geschrieben:

# H1
## H2
### H3
#### H4
##### H5
###### H6

Für H1 und H2 werden zwei alternative Schreibweisen akzeptiert:

H1
==
H2
--

Bitte beachten Sie, dass die Anzahl der gleichen Anzeichen oder Striche mit den Zahlen der Zeichen der Überschrift übereinstimmen muss.

Text betonen

Um den Text zu betonen, werden diese Elemente unterstützt:

  • Kursivschrift: einzelne Sternchen oder einzelne Unterstriche
    --
    * wichtig* und _Also wichtig_
    --
  • Fetthaltiger Text: Doppelsternchen oder doppelte Unterstriche
    --
    ** Wichtig ** und __also wichtig______
    --
  • Überschrittlicher Text: Doppelte Tildes
    --
    ~~ Text ~~
    --

Listen

Markdown unterstützt ungeordnete und bestellte Listen. Bestellte Listen beginnen mit einem Sternchen, einem Plus oder einem Minuszeichen. Bestellte Listen beginnen einfach mit einer Ziffer. Um Sublists zu erstellen, geben Sie das ListItem durch zwei Räume (Markdown, Stackedit) oder vier Räume (PANDOC) ein, wie Sie unten sehen:

1. Früchte
* Apfel
* Banane
2. Getränke
+ Wasser
+ Milch

Bilder

Der einfachste Weg ist, den Inline -Stil wie folgt zu verwenden:

![Debian Logo] (Debian-Logo.PNG "Debian Logo")

Dies zeigt das referenzierte Bild an. Sobald Sie den Mauszeiger über das Bild bewegen, sehen Sie den entsprechenden Beschreibungstext.

Code und Syntax -Hervorhebung

Es gibt zwei Varianten - Inline -Code- und Codeblöcke. Inline -Code ist in drei Backticks wie "'Print („ Hallo, Welt!")" '. Codeblöcke beginnen und enden auch mit drei Backticks, aber in separaten Zeilen wie folgt:

"
Druck („Hallo, Welt!”))
"

Markdown unterstützt keine Syntax -Hervorhebung, sondern Dialekte wie Markdown hier.

Tische

Markdown unterstützt keine Tabellen, sondern Erweiterungen wie GFM und Markdown hier.

Block Zitate

Blockquoten beginnen einfach mit einem ">" -Schild. Es wird sehr praktisch, Text zu zitieren.

> "Oh! Es ist absurd, eine harte und schnelle Regel darüber zu haben, was man sollte
> lesen und was man nicht sollte. Mehr als die Hälfte der modernen Kultur hängt ab
> darüber, was man nicht lesen sollte."
>
> Die Wichtigkeit, ernst zu sein. (Oscar Wilde)

Links

Links beziehen sich auf andere Dokumente oder auf Abschnitte in der aktuellen. Der Schreibstil ähnelt den Bildern und besteht aus der Linkbeschreibung in quadratischen Klammern und der URL in regulären Klammern.

[Ich bin ein Link im Inline-Stil] (https: // linuxhint.com)

Darüber hinaus können Sie einen alternativen Text hinzufügen:

[Ich bin ein Link im Inline-Stil mit zusätzlichem Text] (https: // linuxhint.com "LinuxHint")

Links können wie folgt verwiesen werden:

[LinuxHint] [1]

etwas Text

[1]: https: // linuxhint.com

Auf diese Weise können Sie am Ende Ihres Dokuments problemlos Listen von Referenzen erstellen, da dies in wissenschaftlichen Dokumenten üblich ist.

Abschluss

Markdown ist ziemlich einfach und ein Muss für alle, die Dokumentation durchführen und regelmäßig Inhalte veröffentlichen. Es ist eine große Freude, es zu benutzen.

Verweise

  • Stackedit, https: // stackedit.io
  • Pandoc, http: // pandoc.org/
  • Markdown, https: // dagingfireball.net/projects/markdown/
  • Markdown -Cheatsheet, https: // github.com/adam-p/markdown-hier/wiki/markdown-Cheatsblatt