Twitch, GitHub, Blogs, Discord. Es gibt viele Gelegenheiten Markdown einzusetzen. Aber wie genau funktioniert das und was ist Markdown eigentlich? In unserem kleinen Leitfaden findest du die Antworten dazu.
Markdown ist eine sogenannte Auszeichnungssprache. Sie ermöglicht es mit minimalem Code Struktur in einen Text zu bekommen. Aber wie genau macht man das nun?
Wichtig ist, dass deine Textdatei eine .md Datei ist. Hiermit markierst du die Formatierung Markdown und spezielle Texteditoren oder auch GitHub wissen, wie sie deinen Text aufbereiten sollen.
Überschriften
Überschriften werden mit # gekennzeichnet. Dabei ist ein # die größt mögliche Überschrift mit der höchsten Priorität. Beispiel: Die Überschrift für diesen Absatz wurde mit zwei Hashtags versehen ## Überschriften und ist damit kleiner als der Titel des Artikels, der mit nur einem Hashtag geschrieben wurde.
Checkboxen
[ ] mit einem Leerzeichen zwischen den offenen eckigen Klammern erhältst du eine Checkbox. Anklickbar ist diese im Text leider nicht.
[x] um deine Box als erledigt zu markieren setze einfach ein x zwischen die eckigen Klammern.
Links
Generell werden Links ganz normal angezeigt, wenn du deinem Link aber einen bestimmten Namen geben möchtest, musst du diesen anders aufbauen:
[workshops.DE](https://workshops.de) daraus ergibt sich workshops.DE.
(Code)Highlights
Nun siehst du im Laufe dieses Textes, dass kleine Bereiche immer wieder hervorgehoben werden. Um Textbereiche zu highlighten setzt du deinen Text zwischen zwei ` Backticks.
Wenn du hingegen drei Backticks nutzt markiert dies den Start eines Codeblocks. Auch diesen musst du mit ebenfalls drei Backticks wieder beenden. Code den du in einen Codeblock schreibst wird wie in einem Editor gehighlighted. Hierfür musst du aber vorher angeben um welche Art Code es sich handelt.
<html></html>
Hierfür haben wir hinter die ersten drei Backticks html als Erkennung geschrieben, nach einem Absatz den Code selbst <html></html> und nach einem weiteren Absatz haben wir den Block mit drei weiteren Backticks beendet.
Zitate
Um einen ganzen Textbereich zum Beispiel als Zitat hervorzuheben kannst du deinen Text mit
>starten.
Schriften
Fettgedrucktes gibst du mit jeweils zwei Sternen an Anfang und Ende an **Schulungen**
Kursivschrift gibst du durch jeweils einen Stern am Anfang und Ende an *Teilnehmer:innen*
Unterstrichen gibst du durch jeweils zwei Unterstriche am Anfang und am Ende an __Workshops__
Durchgestrichen gibst du durch jeweils zwei Tilden am Anfang und am Ende an ~~Durchgestrichen~~
Listen
- Angular
- React
- Vue
Eine ungeordnete Liste erhältst du, indem du - vor dein Textstück schreibst. Auch eine geordnete Liste ist ganz leicht zu erhalten, indem du sie nummerierst:
- Docker & Kubernetes
- Angular Advanced
- TypeScript
Emojis
Emojis können durch entweder die korrekten Befehle eingefügt werden z.B. :joy: :joy:
Bei einem Windows-Betriebssystem hast du außerdem die Option das Emoji-Menü über die Tastenkombination Windowstaste + . aufzurufen oder mit einem Rechtsklick der Maus im Textfeld den Reiter Emoji im Dropdown-Menü anwählen, um das gewünschte Emoji einzufügen 😍
Bei macOS kommst du mit der Tastenkombination Control+ Command + Space an das Emoji-Menü heran.
Unterschiedliche Programme
Zum Schluss sei gesagt, dass jedes Programm ein klein wenig anders reagiert. In Discord beispielsweise könnt ihr mit ||spoiler|| markieren. Den Befehlt kennt GitHub aber zum Beispiel nicht.
Tabelle zum einfachen Nachschlagen der Befehle
| Komponente | Befehle |
|---|---|
| Überschrift | # H1 ## H2 ### H3 |
| Checkbox | [ ] [x] |
| Links |
[titel](https://www.beispiel.de) |
| Highlights | ` |
| Codeblocks | ``` |
| Zitate | > |
| Fett |
**fett** |
| Kursiv |
*kursiv* |
| Unterstrichen |
__unterstrichen__ |
| Durchgestrichen |
~~Durchgestrichen~~ |
| Ungeordnete Liste | - - - |
| Geordnete Liste | 1. 2. 3. |
