Inhaltsverzeichnis
Was ist Markdown?Es ist genauso definiert wie Software, die in . geschrieben ist Prol, die den in HTML geschriebenen Text umwandelt und zusätzlich die Syntax, die verwendet wird, um das erwartete HTML-Ergebnis zu erreichen. Eine Syntax, die für jeden, der im Web schreiben möchte, einfach ist, ohne dass er sich damit auskennen muss.
Heutzutage unterstützen die meisten Content-Manager und sogar viele E-Mail-Clients die Verwendung der Markdown-Syntax nativ, um die Erstellung von formatiertem Text zu erleichtern, ohne dass Stile implementiert oder HTML-Kenntnisse erforderlich sind. Diese Handler verwenden einen Parser, um Markdown-Text in HTML zu konvertieren.
MarkDown und Dokumentation
Es ist sehr nützlich, viele Dokumentationstools von Markdown zu lernen; wikia, onenote, evernote, alfresco unterstützen es nativ oder mit Hilfe von Dritten. Es ist wichtig, eine Dokumentation der Prozesse und möglicher Probleme zu haben, aber noch wichtiger ist es, sie auch von der Konsole aus sauber und sauber zu halten, und Markdown ist hier, um uns dabei zu helfen.
Absätze
Wenn wir normal in einem gewöhnlichen Editor schreiben würden, um einen Absatz zu definieren, würden wir einfach ein paar drücken:
Eintreten
Und wir werden sehen, wie unser Cursor ein paar Zeilen nach unten geht, um einen neuen Absatz zu schreiben.In HTML ist es bekannt als des Absatzes.
In Markdown ist es so einfach wie in einem normalen Editor.
Außerdem haben wir den Vorteil, dass ein einzelner Zeilenumbruch den Text nicht in mehrere Zeilen aufteilt, wenn wir so etwas schreiben:
Ein Text. Ein anderer Text.Es wird so aussehen:
Ein Text. Ein anderer Text.Die Verwendung mehrerer Trennlinien reduziert ebenfalls auf einen einzigen Trennraum zwischen den Absätzen
Kopfzeilen
In einem normalen Editor benötigen wir die Symbolleiste, um einen Überschriftenstil für einen Text zu definieren, oder wenn Sie sich etwas unordentlich fühlen, reicht es aus, die Schriftgröße zu erhöhen und sie fett zu machen.
In HTML sind sie bekannt als
,
, usw. aus der Kopfzeile.
Bei Markdown ist es ganz einfach, man muss nur das Zahlenzeichen (#) als Präfix an die Kopfzeile setzen, je mehr davon haben, desto niedriger wird die Kopfzeile bis maximal 6.
Zum Beispiel eine Kopfzeile (der größte) und einer sie würden so geschrieben:
# Große Kopfzeile ### Kleine Kopfzeile
und das Ergebnis wird so sein.
Bei Markdown ist es ganz einfach, man muss nur das Zahlenzeichen (#) als Präfix an die Kopfzeile setzen, je mehr davon haben, desto niedriger wird die Kopfzeile bis maximal 6.
Zum Beispiel eine Kopfzeile (der größte) und einer sie würden so geschrieben:
# Große Kopfzeile ### Kleine Kopfzeileund das Ergebnis wird so sein.
Toller Header
Kleine Kopfzeile
Trennzeichen können in einfachen Editoren normalerweise nicht gezeichnet werden.
VERGRÖSSERN
In HTML werden sie horizontaler Regeln.Sie werden durch Eingabe von 3 oder mehr Sternchen oder Bindestrichen abgegrenzt. Sie können durch ein Leerzeichen gefolgt oder getrennt werden, es ist gleichgültig.
* * * *** - - - ---Betonung
Diese Formatierung wird als kursiv und fett bezeichnet.
In HTML wäre es Ja .
Um Text im kursiven Format zu erstellen, müssen Sie den Text nur zwischen einzelnen Sternchen oder Unterstrichen und für fett zwischen Doppelten einschließen:
* kursiver Text. * _ kursiver Text._ ** fetter Text. ** __ fetter Text .__Es würde ungefähr so aussehen:
kursiver Text. fetter Text.
Durchgestrichen
Auf diese Weise können Sie Text so platzieren, als würden wir ihn durchstreichen, was häufig für die Versionskontrolle verwendet wird. o Fehler, die in einer Anwendung oder einem System korrigiert wurden.
In HTML wäre es durchgestrichen.
Es reicht aus, den Text zwischen doppelten Großbuchstaben oder Tilden zu umschließen:
~~ durchgestrichener Text. ~~Diese Option ist kein Standard und funktioniert möglicherweise nicht in allen Editoren.
Zitate
Der Zitierstil ist in einem gängigen Texteditor normalerweise nicht leicht zu finden
In HTML wäre es
.
Wir müssen nur das "größer als"-Zeichen (>) als Präfix an den folgenden Text setzen (ähnlich der Adressierung unter Linux)> Dies ist ein Zitat.Es würde aussehen:Dies ist ein Zitat.
Listen
Um eine Liste von Zielen zu definieren, verwenden wir normalerweise die Funktionalität von Aufzählungszeichen für Listen ohne bestimmte Reihenfolge und nummerierte Listen.
In HTML wäre es für ungeordnete Listen, für geordnete Listen und um jedes Element in der Liste zu definieren.
In Markdown definieren wir sie einfach, indem wir jedem Element ein Sternchen (*), einen Bindestrich (-) oder ein Pluszeichen (+) für ungeordnete Listen voranstellen. Bei geordneten Listen setzen wir die entsprechende Nummer und einen Punkt voran:* Tutorial schreiben * In Solvetic veröffentlichen. 1. Neues Tutorial. 3. Wählen Sie einen Abschnitt und eine Ebene aus. 2. Formate korrigieren und veröffentlichen.Es würde so aussehen:
- Tutorial schreiben.
- Poste es auf Solvetic.
In Aufzählungslisten wird die Hierarchie der Nummer nicht beachtet, die Position innerhalb dieser wird verwendet.
- Neues Tutorial.
- Wählen Sie einen Abschnitt und eine Ebene aus.
- Formate korrigieren und veröffentlichen.
Links
Das Platzieren von Links ist äußerst nützlich und wichtig, da Sie auf Inhalte auf eine externe Dokumentation oder ein Tutorial verweisen können.
Beispiel:Der Nginx-Server wurde mit fail2ban mit [tutorial-solvetic] gesichert (http://www.solvetic.com/tutoriales/article/1963-instalar-fail2ban-y-asociarlo-con-ssh-y-nginx/)Wir setzen in Klammern [] der Text, den wir wollen, hat den Link und dann setzen wir ihn in Klammern () der Ziellink.
Wenn Sie es vorziehen, es geordneter zu machen, als die Referenzen in der Mitte Ihres Textes zu haben, können Sie dies auch auf folgende Weise tun:Der Nginx-Server wurde mit fail2ban unter Verwendung von [1]……… [1] gesichert: http://www.solvetic.com/tutoriales/article/1963-instalar-fail2ban-y-asociarlo-con-ssh-ynginx /Eine andere Möglichkeit wäre:Der Nginx-Server wurde mit fail2ban mit [fail2ban-nginx-solvetic]……… [ssh-nginx-solvetic] gesichert: http://www.solvetic.com/tutoriales/article/1963-instalar-fail2ban-y-asociarlo - con-ssh-y-nginx /Fügen Sie nun Bilder hinzu.
Bilder
Wir können Bilder hinzufügen, die Links fast ähneln, indem wir a hinzufügen! Vor jedem muss ich betonen, dass ich sie nicht von einem Terminal aus sehen kann, also nicht direkt.! [alternativer Text] (Bild-URL)Wir können die gleichen Optionen der Links verwenden, wenn wir es besser organisiert haben möchten.
Bretter
Normalerweise lege ich Zugangsdaten in Tabellen von Servern oder Diensten ab.
Dazu zeichnen wir die Zeilen der Tabelle mit Pipes (|) zur Abgrenzung der Spalten und Bindestrichen (-), um die Kopfzeile vom Rest der Zeilen zu trennen:| Service | Benutzer | Schlüssel | | ------------- | --------- | ----------- | | FTP | Solvent | aw-D.wak | | SSH | admin | 2 -.- Uhr, |Wir hätten so etwas:
Die Rohre müssen nicht ausgerichtet werden und die "Kanten" sind optional, zum Beispiel:Überschrift 1 | Überschrift 2 --- | --- versuchen wir es | lass uns etwas versuchen | etwas anderes. Dies würde dieselbe Tabelle generieren.Sie können den Text in Ihren Spalten auch ausrichten, indem Sie das Doppelpunktsymbol ( auf dem mit Bindestrich gemachten Trennzeichen auf der Seite, die aufgereiht werden soll:| Linksbündig. | Zentriert | Rechts ausgerichtet. | |: ------------------- |: --------: | ----------------- -: | | testen | testen | testen |Nicht alle Editoren akzeptieren Tabellen in Markdown.
Code
Wir können unseren Code mit Markdown hervorheben und er unterscheidet sich von einer Sprache zur anderen.Dreifache Backtick-Syntax
Das Platzieren dieser Art von Blöcken ist sehr einfach, wir müssen nur den Codeblock einschließen, den wir eingeben möchten.e 3 Backticks (`` ``) gefolgt vom Namen der Sprache, zu der der Code gehört, den Sie platzieren möchten:`` `Sprache x = y …` ``Ein Beispiel für JavaScript-Code würde in etwa so aussehen:`` `` js function test() {console.log ('testing!')} ''Dies würde einen schönen Codeblock mit hervorgehobener Syntax für Javascript generieren:Funktionstest () {console.log ('testing!')}Syntax mit vorangestelltem Abstand
Eine andere Möglichkeit, vorformatierten Text oder Code ohne angegebene Sprache zu platzieren, besteht darin, unseren Text mit 4 Leerzeichen "einzurücken". Wir würden ihn so schreiben:x = y // Beachten Sie, dass zwischen dem Rand und dem, was wir schreiben, 4 Leerzeichen sind.wir werden dieses ergebnis haben:x = y // Beachten Sie, dass zwischen dem Rand und dem, was wir schreiben, 4 Leerzeichen sind.Der Standard akzeptiert nur die Option mit Vorabstand.
SchlussfolgerungenEin gutes Dokumentationssystem muss schnell, flexibel und einfach sein. Punkte, die Markdown auf sehr gute Weise abdeckt, dürfen wir nicht vergessen, seine saubere Syntax für die Augen, die zu berücksichtigen ist, wenn wir die Dokumentation von einem Terminal mit VIM / EMACS überprüfen möchten. Der Eintrag hat einen Ansatz für Systemadministratoren, kann aber für alle Arten von Fachleuten oder Studenten sehr nützlich sein.Ich hoffe, dass alle Zweifel oder Vorschläge klar sind, hinterlassen Sie sie in den Kommentaren.Hat dir dieses Tutorial gefallen und geholfen?Sie können den Autor belohnen, indem Sie diesen Knopf drücken, um ihm einen positiven Punkt zu geben