So arbeiten Sie mit GitHub Flavored Markdown in Linux
Markdown ist eine Formatierungssprache, die für das Web entwickelt wurde. Der Zweck von Markdown ist es, uns das Leben beim Schreiben im Internet zu erleichtern. Im Laufe der Zeit werden viele Arten von Markdown erstellt. Aber in diesem Artikel wird unser Fokus hauptsächlich auf Github Flavored Markdown (GFM) liegen.
Github basiert auf CommonMark. Es gibt viele zusätzliche Funktionen, die in GFM unterstützt werden, wie Tabellen, Code-Fencing usw. Schauen wir uns die Syntax für GFM an und wie man sie in verschiedenen Fällen verwendet.
Ich verwende VScode, um dies zu demonstrieren, aber Sie können jeden Linux-Editor auswählen, der für Sie geeignet ist. Einige Editoren wie Atom und Vscode bieten Markdown-Unterstützung und für einige Editoren müssen wir ein Markdown-Plugin installieren.
Um mit Markdown zu arbeiten, sollte die Datei mit .md oder .markdown als Erweiterung gespeichert werden.
Hinzufügen von Überschriften zum Markdown-Editor
Es gibt 6 Überschriftenebenen, die im Markdown unterstützt werden. Um eine Überschrift zu erstellen, verwenden Sie das Rautensymbol (#), gefolgt von einem Leerzeichen und dem Namen der Überschrift. Je höher der Hash-Wert, desto kleiner ist die Größe der Überschrift.
HINWEIS: H1 und H2 haben standardmäßig einen Unterstreichungsstil.
# Heading1
## Heading2
### Heading3
#### Heading4
##### Heading5
###### Heading 6
Manchmal möchten Sie vielleicht die Überschrift in Richtung Mitte ausrichten. Die traurige Geschichte ist jedoch, dass die Ausrichtung im Markdown standardmäßig nicht unterstützt wird. Standardmäßig werden Überschriften linksbündig gerendert. Sie können HTML/CSS-Tags in Markdown einbetten, um eine Ausrichtung zu erreichen.
<h1 style="text-align:center">MARKDOWN</h1>
<h1 style="text-align:left">MARKDOWN</h1>
<h1 style="text-align:right">MARKDOWN</h1>
<h1 style="text-align:justify">MARKDOWN</h1>
Hinzufügen von Kommentaren zum Markdown-Editor
Kommentare sind eine Möglichkeit, bestimmte Dinge zu dokumentieren, um den Code/die Dokumente besser zu verstehen. Dies wird von der Markdown-Engine nicht gerendert.
<!--
Comment block
-->
So rendern Sie Text als einzelne Zeile
Wenn Sie etwas in separaten Zeilen eingeben, wird es normalerweise nacheinander durch Markdown als einzelne Zeile gerendert.
Sie können Zeilenumbrüche auf zwei Arten erstellen.
- Weicher Zeilenumbruch
- Hardline-Break
Weiche Zeilenumbrüche können erstellt werden, indem am Ende der Zeile zwei Leerzeichen hinzugefügt werden. Auf diese Weise wird beim Markdown jede Zeile als separate Zeilen gerendert.
Hardline-Umbrüche können erstellt werden, indem zwischen jeder Zeile eine leere Zeile eingefügt wird.
So fügen Sie horizontale Linien hinzu
Die horizontale Linie kann erstellt werden, indem drei oder mehr Sternchen (*), Bindestriche(-)) oder Unterstriche(_) in einer einzigen Zeile platziert werden. Es ist auch in Ordnung, Leerzeichen zwischen ihnen einzufügen.
* * *
---
___
So machen Sie einen Text fett
Um ein Wort oder Zeilen fett zu formatieren, schließen Sie das Wort oder die Zeilen in doppelte Sternchen (**) oder doppelten Unterstrich (__) ein.
**Making this sentence bold using double asterisks.**
__Making this sentence bold using double underscore.__
Wie man einen Text kursiv macht
Um Wörter oder Zeilen kursiv zu setzen, schließen Sie das Wort oder die Zeilen zwischen einzelnen Sternchen (*) oder einem einfachen Unterstrich (_) ein.
*Making this line to be italicized using asterisks.*
_Making this line to be italicized using underscore._
So fügen Sie Zeilen durchgestrichen hinzu
Um irgendetwas zu treffen, muss man eine doppelte Tilde verwenden. Umschließen Sie alles, was Sie durchstreichen möchten, zwischen doppelten Tilden (~~).
I am just striking the word ~~Howdy~~.
~~I am striking off the entire line.~~
So fügen Sie ein Blockangebot hinzu
Verwenden Sie Größer als ein Symbol (>) für Blockquote.
> Single line blockquote.
Sehen Sie, wie das folgende Blockzitat gerendert wird. Beide Zeilen werden in derselben Zeile gerendert.
> first line
> Second line
> Third line
> Fourth line
Sie können den Zeilenumbruch verwenden, indem Sie am Ende jeder Zeile zwei Leerzeichen lassen. Auf diese Weise wird nicht jede Zeile in einer einzigen Zeile gerendert.
Lassen Sie die alternativen Zeilen leer und stellen Sie ein Symbol vorangestellt, dem größer als ein Symbol vorangestellt ist. Auf diese Weise können Sie einen Zeilenumbruch zwischen jeder Zeile innerhalb desselben Blocks erstellen.
> first line
>
> Second line
>
> Third line
>
> Fourth line
Sie können auch verschachtelte Blockzitate erstellen, indem Sie zwei Größer-als-Symbole (>>) hinzufügen.
Erstellen von Inline-Code
Verwenden Sie BACKTICK, um Inline-Code zu erstellen. Im folgenden Beispiel wird veranschaulicht, wie Inlinecode erstellt wird. Schauen Sie sich die Wortnoten und die Readme-Datei an, die als Inline-Code gerendert wurde.
Markdown is one of the best tools for taking `notes` and creating `readme` files.
Hinzufügen von Codeblock-Syntaxhervorhebungen
Fügen Sie Tabulatoren oder 4 Leerzeichen hinzu und platzieren Sie Ihren Code, um ihn als Codeblock zu rendern. Alternativ können Sie den Code zwischen drei Backticks platzieren, damit der Block als Codeblock gerendert wird. Das wichtige Feature, das hier zu beachten ist, ist die Syntaxhervorhebung. Wenn Sie den Code innerhalb des Blocks platzieren, wird normalerweise kein Farbschema darauf angewendet.
```
echo "Hello world"
```
Schauen Sie sich nun das gleiche Beispiel an, das Farbschema wird automatisch angewendet. Dies ist möglich, indem der Name der Programmiersprache nach drei Backticks hinzugefügt wird, wodurch das Farbschema auf den Code angewendet wird.
```bash
echo "Hello world"
```
Beispiel für Python-Code.
```python
def fp():
print("Hello World!!!")
fp()
```
Beispiel für eine SQL-Abfrage.
```sql
SELECT MAX(SALARY_EMP) FROM EMPLOYEE_TABLE
WHERE SALARY_EMP<(SELECT MAX(SALARY_EMP) FROM EMPLOYEE_TABLE)
```
Erstellen von geordneten und ungeordneten Listen
Elemente können im Markdown in geordnete und ungeordnete Listen unterteilt werden. Um eine geordnete Liste zu erstellen, fügen Sie Zahlen gefolgt von einem Punkt hinzu. Der interessante Teil, der hier zu beachten ist, ist, dass die Zahl nicht fortlaufend sein muss. Die Markdown-Engine ist schlau genug, um zu verstehen, dass es sich um eine geordnete Liste handelt, auch wenn wir die nicht sequenzielle Reihenfolge vornehmen.
Im folgenden Beispiel sehen Sie, dass ich eine geordnete Liste mit nicht sequenzieller Reihenfolge (10, 15, 150) erstellt habe, aber die Markdown-Engine sie in der richtigen Reihenfolge rendert. Sie können auch eine verschachtelte Liste erstellen, wie im Bild gezeigt.
Um eine ungeordnete Liste zu erstellen, verwenden Sie das Pluszeichen (+), Sternchen (*) oder den Bindestrich (-), gefolgt von einem Leerzeichen und dem Inhalt der Liste. Ähnlich wie bei der geordneten Liste können Sie auch hier eine verschachtelte Liste erstellen.
Aufgabenliste erstellen
Dies ist eine Besonderheit von GFM. Sie können eine Aufgabenliste erstellen, wie in der folgenden Abbildung gezeigt. Um die Aufgabe als erledigt zu markieren, müssen Sie ein "x" zwischen den eckigen Klammern hinzufügen, wie im Bild gezeigt.
Hinzufügen von Links zu Text
Um einen Link hinzuzufügen, befolgen Sie die folgende Syntax.
[Tecmint](https://linux-console.net "The best site for Linux")
Lassen Sie uns die Syntax in 3 Teile unterteilen.
- Anzuzeigender Text – Dies ist der Text, der in quadratischen Klammern ([Tecmint]) platziert wird.
- Link – Sie platzieren den eigentlichen Link in der Klammer.
- Titel – Wenn Sie mit der Maus über den Text fahren, wird ein Tooltip für den Link angezeigt. Der Titel sollte in Anführungszeichen gesetzt werden, wie im Bild gezeigt.
Auf dem Bild unten können Sie sehen, dass "Tecmint" mein Anzeigetext ist, und wenn ich darauf klicke, werde ich zu "linux-console.net" weitergeleitet.
Sie können auch Verknüpfungen erstellen, indem Sie sie < > in spitze Klammern setzen.
Hinzufügen von Links zu Bildern
Die Syntax für das Bild sieht ähnlich aus wie beim Hinzufügen von Links. Um ein Bild hinzuzufügen, befolgen Sie die folgende Syntax.
Lassen Sie uns die Syntax in 3 Teile unterteilen.
- Alternativer Text – Alternativer Text wird in eckige Klammern gesetzt (![ Alt-Text]). Wenn ein Bild defekt ist oder nicht geladen werden kann, wird dieser Text zusammen mit einem defekten Symbol angezeigt.
- Link – In den Klammern platzieren Sie den eigentlichen Link zum Bild.
- Titel – Wenn Sie mit der Maus über das Bild fahren, wird der Name des Bildes angezeigt. Der Titel sollte in Anführungszeichen gesetzt werden, wie im Bild gezeigt.
Sie können auch einen Link mit Bildern erstellen. Wenn ein Benutzer auf das Bild klickt, wird es zu einem externen Link weitergeleitet. Die Syntax bleibt mit wenigen Änderungen gleich. Umgeben Sie die gleiche Syntax, die wir verwendet haben, um ein Bild in eckigen Klammern einzufügen, gefolgt von einem Link in der Klammer.
[](https://en.wikipedia.org/wiki/Markdown)
Erstellen einer Tabelle
Tabellen werden in der ursprünglichen Variante von Markdown nicht unterstützt. Es ist eine der Besonderheiten, die GFM mit sich bringt. Sehen wir uns Schritt für Schritt an, wie Sie eine Tabelle erstellen.
Der erste Teil besteht darin, Spaltennamen zu erstellen. Spaltennamen können erstellt werden, indem sie durch senkrechte Striche (|) getrennt werden.
| EMPLOYEE_NAME | EMPLOYEE_AGE | EMPLOYEE_ID |
Verwenden Sie in der zweiten Zeile Bindestriche (-) in Kombination mit einem Doppelpunkt (:). Bindestriche teilen der Markdown-Engine mit, dass dies als Tabelle gerendert werden soll, und der Doppelpunkt entscheidet, ob unser Text zentriert, links oder rechtsbündig ausgerichtet sein soll.
| EMPLOYEE_NAME | EMPLOYEE_AGE | EMPLOYEE_ID |
|:-------------:|:-------------|------------:|
:---: ⇒ Center alignment
:--- ⇒ Left alignment
---: ⇒ Right alignment
Von der dritten Zeile aus können Sie mit der Erstellung von Datensätzen beginnen. Datensätze sollten durch einen senkrechten Strich (|) getrennt werden.
| EMPLOYEE_NAME | EMPLOYEE_AGE | EMPLOYEE_ID |
|:-------------:|:-------------|------------:|
| Ravi | 30 | 127 |
| karthick | 27 | 128 |
Auf dem obigen Bild können Sie sehen, dass die Tabelle ordnungsgemäß gerendert wird. Spalte 1 ist zentriert, die Spalten 2 und 3 sind links- und rechtsbündig. Wenn Sie Vscode verwenden, können Sie "Markdown Table Prettifier" verwenden, um die Tabelle ordentlich zu formatieren.
Erstellen Sie ein Emoji
GFM unterstützt eine breite Palette von Emojis. Werfen Sie einen Blick auf den Emoji-Spickzettel.
Das war's für diesen Artikel. Wenn Sie Feedback haben, posten Sie es bitte im Kommentarbereich.