Markdown -Tutorial - vom Setup zur Syntax
Gleichzeitig ist der Markdown sehr leicht und flexibel. Der beliebteste Anwendungsfall für Markdown ist für Lizenz- und Readme -Dateien in einem Github -Repository, wird jedoch auch in immer mehr CMS für die Verwaltung von Blog -Posts und sogar in das Schreiben von Forschungsarbeiten integriert. Sie können mathematische Gleichungen mit Plugins für Latex machen.
Es wird hauptsächlich von Entwicklern verwendet. Es ist sehr hilfreich bei der Erstellung von Tutorials und Dokumentation dank der Syntax -Hervorhebung für mehrere Sprachen und Unterstützung für Bilder und sogar GIFs.
Beginnen wir mit einer Setup.
ATOM -Texteditor und Markdown -Vorschau
Sie können Atom -Texteditor oder Visual Studio -Code herunterladen und installieren, um mitzumachen. Atom und VS-Code haben beide vorinstallierte Plugins für die Markdown-Vorschau. Hier wird Atom verwendet, aber Syntax würde ungefähr gleich bleiben, egal welchen Texteditor Sie verwenden.
Stellen Sie bei Atom sicher, dass das Markdown -Vorschau -Paket aktiviert ist (es ist tatsächlich standardmäßig aktiviert). Erstellen Sie einen Ordner für dieses Markdown -Tutorial und öffnen Sie dort eine neue Datei (Strg + n) und geben Sie dort den folgenden Text ein.
# Dies ist eine Überschrift___
## Dies ist auch eine Überschrift
Hier ist ein Text
Speichern Sie die Datei (CRTL + S) mit a .MD -Erweiterung. Zum Beispiel können Sie Ihre Datei als Test benennen.MD und die .MD -Teil wird Atom mitteilen, dass es sich um eine Markdown -Datei handelt und die Erweiterung wie beabsichtigt funktioniert. Sie können eine Vorschau erstellen, indem Sie die folgenden Schlüsselbindungen (Strg+Shift+M) verwenden, die in einer neuen Scheibe neben der Rohtextdatei angezeigt wird.
Sie können das Vorschaufel-Bereich schließen, indem Sie dieselbe Schlüsselbindung oder die GUI selbst verwenden.
Mit allem, was eingerichtet ist.
Markdown -Syntax
Wie bereits erwähnt, ist die Hauptmotivation hinter dem Markdown die Lesbarkeit. Dies bedeutet, dass keine obskuren Tags oder verschachtelten Tags oder andere Verwirrungen induzieren, die Strings induzieren. Stattdessen können wir mit '#' Symbol beginnen, um anzuzeigen, dass diese bestimmte Zeile eine Überschrift ist.
# Ist eine Überschrift.## zeigt auch die Überschrift an, jedoch mit kleinerer Schriftgröße.
### Sie können nacheinander kleinere Größen gehen
Zeilenumbrüche
Markdown fügt den gesamten Text weiterhin in einen riesigen Absatz ein, selbst wenn der rohe Text in verschiedene Zeilen unterteilt ist. Um dies zu mildern, können Sie zwei Räume am Ende einer Linie verwenden und dann einen neuen Charakter setzen (dh, Hit ) oder verwenden Sie einfach zwei neue Zeilenzeichen für einen etwas anderen Effekt, wie unten gezeigt.
Der Satz „Deshalb ist der Grund…“ in einer neuen Linie begann, ist aber nicht von der vorherigen Zeile abgesehen, während mit zwei Newlines eine breitere Trennung erzeugt wurde.
Horizontale Regel
Die horizontale Regel erstellt, wie der Name schon sagt. Es gibt zwei Methoden zum Erstellen einer horizontalen Regel. Erstens ist die Verwendung von drei oder mehr Unterstrichen, um eine horizontale Regel zu erstellen.
#Überschrift 1___
Absatz und Überschrift werden durch eine horizontale Regel getrennt.
___
Ein weiterer getrennter Abschnitt
Eine andere Option (die ich nicht empfehlen werde) ist die Verwendung von drei oder mehr Strichen '-' 'aber sie werden auch verwendet, um anzuzeigen, dass der Satz unmittelbar über ihnen eine Überschrift ist. Wenn Sie also keine neue Zeile zwischen einem Satz und der horizontalen Regel darunter haben, wird dieser Satz die Form einer Überschrift erfolgt.
Kursivschrift, mutig und gestreift
Die Syntax für die drei ist ziemlich einfach und spricht für sich selbst.
** Das ist fett **__This ist auch mutig
_This ist kursiv
*Dies ist auch Kursivschrift*
~~ Das ist Striften ~~ ~~
Escape-Zeichen
Nun, vielleicht fragen Sie, wie Sie buchstäblich einen Text ** in die endgültige Markdown -Datei schreiben würden, wenn sie dies nur jedes Mal auf fett geändert hat. Dies ist etwas, mit dem sich die meisten Programmiersprachen auch befassen, und die Lösung ähnelt denen - Verwenden Sie einen Backslash -Charakter. Dies funktioniert auch für andere Syntaxelemente und ist nicht speziell für mutiges Styling.
\ ** Dies ist nicht mehr fett \ **Wenn Sie den Backslash -Charakter selbst zeigen möchten, verwenden Sie zwei davon und so weiter.
\\ zeigt sich als einzelner Schrägstrich
Blockquoten und Codeblöcke
Blockquoten und Codeblöcke sind viel einfacher. Ein Blockquote kann verwendet werden, um einen wichtigen Punkt hervorzuheben, auf den Sie die Aufmerksamkeit der Leser auf sich ziehen möchten. Dies kann erreicht werden, indem am Start wie gezeigt die rechten Winkelhalterung verwendet wird.
# Überschrift 1Lorem Ipsum Dolor Sit Amet, Consectetur Adipiscing Elit, SED do eiusmod Temporal Incididunt UT
LABORE ET DOLORE MAGNA Aliqua. Ut enim ad minim minim
Nisi ut aliquip ex ea Commodo folgt. DUIS AUTE IROR DOLOR in Verpackung in Voluptate
velit esse cillum dolore eu fugiat nulla pariatur. Außer ERINT SINT OCCAECAT CURIDATAT NON
PROGIDENT, SUNT IN CULPA Qui Officia Deserunt Mollit Anim Id Est Laborum.
> Dies ist eine nette Zusammenfassung eines Unterabschnitts Ihres Dokuments. Ein paar Zeilen, die stehen
Aus dem Rest des Inhalts.
Der Inhalt geht weiter.
So sieht es aus, wenn es gerendert wird.
Stellen Sie für Codeblöcke einfach die Zeilen die Zeilen um 4 Leerzeichen oder mehr ein. Das ist wirklich
praktisch für Entwickler und Betreiber, die ihre Arbeit dokumentieren möchten. Wir würden später sehen, wie wir das noch besser machen können.
Hyperlinks und Bilder
Für Hyperlinks ist die Syntax ziemlich einfach. Der sichtbare Text ist in quadratischen Klammern und der URL, auf die er zeigt, in runden Klammern geschrieben, direkt daneben.
Für Bilder ist die Syntax ähnlich, außer dass sie mit einem Ausrufezeichen beginnt. Sie können einen relativen Pfad in Ihrem Projektordner verwenden, der auf das Bild hinweist, oder Sie können eine öffentliche URL haben.
## Illustrieren von Hyperlink und Bildsyntax___
Sie sollten uns [uns] besuchen (https: // linuxhint.com) öfter
So werden Bilder eingebettet.
![SMUGPUG] (https: // hochladen.Wikimedia.org/wikipedia/commons/d/d2/bonny_bonita.JPG)
Tische
Das Erstellen von Tabellen in Markdown umfasst buchstäblich das Zeichnen eines ASCII -Porträts (Unicode, um genau) eines Tabelle zu zeichnen.
## Tische| Spalte 1 | Spalte 2 | Spalte 3 |
| --------- | --------- | --------- |
| Erste Reihe | Erste Reihe | Erste Reihe |
| Zweite Reihe | Zweite Reihe | Zweite Reihe |
Die Syntax muss nicht genau von einer Zeile zur anderen ausgerichtet sein, aber das Rohrzeichen wird verwendet, um in die nächste Spalte zu wechseln, und die nächste Zeile zeigt an, dass die nächste Zeile im Allgemeinen gestartet wurde.
Erweiterter Markdown
Für diejenigen unter Ihnen, die so weit gekommen sind, hier ist der wahre Genuss. Wenn Sie Atom verwenden, können Sie das Markdown -Vorschau -Plugin für die Markdown -Vorschau Plus ersetzen. Das bietet die folgenden Funktionen.
1. Mathematische Gleichungen mit Latex:
Sie können tatsächlich Latex -Skripte zwischen Dollar -Schildern einfügen und es wird als Latex -Skript und in der Vorschau mit Strg+Shitft+X Keybinding angezeigt. Sie müssen nicht einmal alle Latex kennen, nur ein paar Snippets sind genug.
## Illustration Latex___
$$ | \ psi \ rangle = \ alpha | 0 \ rangle + \ beta | \ Rangle $$
2. Satzstellung markieren
Anstatt die Einklebung zu verwenden, um Codeblöcke anzuzeigen. Die Sprachen, deren Syntax unterstützt wird, sind zu zahlreich, um sie hier aufzulisten, aber hier ist ein Beispiel in Python.
## Veranschaulichung der Syntax -Hervorhebung___
"Python
importieren
def my_function ():
print ("Hallo, Welt!"))
Rückkehr 0
"
Es gibt viele Geschmacksrichtungen oder Markdowns. Github hat ein eigenes spezielles Gebräu und die Syntax ist sehr flexibel. Dies soll die Benutzer nicht einschüchtern, sondern eine breitere Vielfalt von ihnen zu erledigen. Es ist eine dieser Sprachen, die man nur eine Untergruppe versteht, die man braucht und benutzt, anstatt sich von den technischen Daten zu stören (es sei denn, Sie interessieren sich für seine technischen Daten!)