Markdown Spickzettel https://strobelstefan.org
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
Markdown/Markdown-Spickzettel.md

18 KiB

Markdown Spickzettel


Inhaltsverzeichnis


Was ist Markdown?

Markdown ist für Menschen eine leicht verständliche und einfach zu erlernende Auszeichnungssprache.

Dateiendung für Markdown

Die Dateiendung .md, in manchen Fällen auch .markdown, steht für "Markdown Documentation". Diese Bezeichnung weist darauf hin, dass jedes .md-File in einer der verfügbaren Dialekte der Markdown-Entwicklungssprachen geschrieben ist. Diese zählen zu den Markup- bzw. Auszeichnungssprachen.

Editoren

Zettlr

Zettlr ist ein schlanker Markdowneditor für das 21. Jahrhundert.

🔗 https://www.zettlr.com/

Ein lesenswerter Beitrag zum Arbeiten mit Markdown-Dokumenten und dem Editor Zettlr findet sich auf 🔗 https://www.hendrik-erz.de/post/how-i-work-part-v-zettlr-and-academic-markdown

Typora

Ist ein Editor speziell für Markdown. Das Programm ist wunderbar einfach zu handhaben und Markdown-Dokumente lassen sich damit sehr gut erstellen und bearbeiten. Mittlerweile hat Typora das Entwicklungsstadium verlassen und ist kostenpflichtig.

🔗 https://typora.io/

Visual Studio Code

Der Editor aus dem Hause Microsoft eignet sich auch sehr gut zum Schreiben von Markdown Dokumenten. Die folgenden Erweiterungen eignen sich sehr gut dafür.

Ebenso wie der Atom Editor gibt es Visual Code Studio für alle gängigen Betriebssysteme. Für (K)Ubuntu wird auf snapcraft.io ein Paket zur Verfügung gestellt.

(K)Ubuntu:

sudo snap install code --classic

Mac OS

brew install --cask visual-studio

Joplin

Ein guter Markdown-Editor ist Joplin.

Ich habe den Editor bereits in meinem Blog vorgestellt. 🔗 Nextcloud – Notizen mit unterschiedlichen Endgeräten bearbeiten

Der Editor eignet sich hervorragend für die Speicherung von Notizen auf Cloud-Diensten, wie z.B. Nextcloud.

Notepad++

Es wird für den beliebten Editor Notepad++ eine Erweiterung angeboten, die sich über die "Plugin-Verwaltung" sehr einfach installieren lässt.

Erweiterungen --> Plugin-Verwaltung

Dort sucht man nach dem Plugin "MarkdownViewer++" und installiert es.

Anschließend lassen sich die Markdown-Dateien in der Vorschau ausgeben.
Die Vorschau wird mit der Tastenkombination Strg++M (Strg + Shift + M) aktiviert.

Bei dem Editor "Notepad++" kann es evtl. zu Problemen in der Preview kommen, wenn man Links setzt. Hier bietet sich ein relativ unkomplizierter Workaround an. Anstatt die Preview im Editor anzeigen zu lassen, kann die Anzeige auch in einem Webbrowser erfolgen. Für die Anzeige ist eine Erweiterung zu installieren.

Webbrowser - Markdown Viewer

Chrome Browser

🔗 Markdown Viewer von simov.github.io

Mozilla Firefox

🔗 Markdown Viewer Webext von Kulero, Cimbali

Metadaten

Metadaten können in Markdown-Dateien hinzugefügt werden.

---
[//]: # (Title: Title)
[//]: # (Author: Author´s Name)
[//]: # (Date: yyyy-mm-dd)
[//]: # (Comment: Kommentare) 
[//]: # (Tags: #tag1, #tag)  
[//]: # (CSS: https://path-to-css)
---

Allgemeine Befehle

Kursiv = *Kursiv*

Fett = **Fett**

Kursiver und fetter Text = ***Kursiver und fetter Text***

Durchgestrichener Text = ~~Dieser Text ist durchgestrichen.~~

Horizontale Linie = ***

Horizontale Linie = ---

Inhaltsverzeichnis einfügen

Die Funktion wird nicht von jedem Markdown-Editor unterstützt.

[TOC]

Ein vollständiges Inhaltsverzeichnis kann mit Visual Studio Code oder Atom erstellt werden, wie bei diesem Dokument. Für beide Editoren sind dafür Erweiterungen notwendig.

Code

Code einfügen = Am Anfang und am Ende einer Zeile

Code Block - Möglichkeit 1:

```text
Code Block
```

Code Block - Möglichkeit 2:

Einrücken um 4 Leerzeichen

Test
Test2
    Test
    Test2

Überschriften

Überschrift 1 = # Überschrift 1
Überschrift 2 = ## Überschrift 2
Überschrift 3 = ### Überschrift 3
Überschrift 4 = #### Überschrift 4
Überschrift 5 = ##### Überschrift 5
Überschrift 6 = ###### Überschrift 6

Zeilenumbruch

Ein Zeilenumbruch wird durch 2 Leerzeichen am Zeilenende erzwungen.

Ohne Zeilenumbruch
Erste Zeile Zweite Zeile

Erste Zeile
Zweite Zeile

Mit Zeilenumbruch
Erste Zeile
Zweite Zeile

Erste Zeile  
Zweite Zeile

Seitenumbruch

Ein Seitenumbruch kann in einem Markdown-Dokument an beliebiger Stelle eingefügt werden. Auf die Markdown Darstellung hat das keinen Einfluss. Der Seitenumbruch wird erst bei einem Export in eine PDF-Datei eingefügt.

<div style="page-break-after: always;"></div>

Checkliste/Aufgabenliste

  • Text
  • Text
- [ ] Text muss angegeben werden
- [ ] Text muss angegeben werden
  • Text
  • Text
* [ ] Text muss angegeben werden
* [ ] Text muss angegeben werden

Ungeordnete Listen

Um mit Markdown eine unsortierte Liste zu erstellen, könnt ihr die Zeichen Plus, Bindestrich oder ein Sternchen verwenden. 1

Liste mit *

  • Listeneintrag
  • Listeneintrag
* Listeneintrag
* Listeneintrag

Liste mit * und Einrückungen

Die einzurückende Zeile ist mit 2 Leerzeichen einzurücken. Je nach verwendetem Markdown-Editor auch mit Tabulator

  • Listeneintrag
  • Listeneintrag
    • Listeneintrag
    • Listeneintrag
* Listeneintrag
* Listeneintrag
  * Listeneintrag
  * Listeneintrag  

Liste mit +

  • Listeneintrag
  • Listeneintrag
+ Listeneintrag
+ Listeneintrag

Liste mit -

  • Listeneintrag
  • Listeneintrag
- Listeneintrag
- Listeneintrag

Geordnete Liste

1. Line
2. Line
    1. Sub-Line
    2. Sub-Line
3. Line
  1. Sub-Line
  2. Sub-Line

Zitate

Zitatebene 1 - Zitat

Zitatebene 2 - Zitat im Zitat

Zitatebene 3 - Zitat im Zitat im Zitat

> Zitatebene 1 - Zitat

>> Zitatebene 2 - Zitat im Zitat

>>> Zitatebene 3 - Zitat im Zitat im Zitat

Verweise innerhalb des Dokuments

Verweis 1

Verweis 2

Verweis 3

  1. Verweis 1
  2. Verweis 2
  3. Verweis 3

Als Code sieht das Ganze dann so aus

1. [Verweis 1](#verweis-1)
2. [Verweis 2](#verweis-2)
3. [Verweis 3](#verweis-3)

Verweise auf andere Dokumente

Es lässt sich ein Link auf ein anderes Dokument einsetzen

README

[README](readme.md)

Verweise auf Abschnitte anderer Dokumente

Verweise auf Abschnitte innerhalb anderer Dokumente sind ebenfalls möglich:

README

[README](readme.md#kaffeespende)

Bilder einfügen

Die grundsätzliche Syntax für das Einfügen bin Bildern sieht wie folgt aus.

![image photo.jpg]
![image photo.jpg Beispiel]
![image photo.jpg "Dies ist ein Beispielbild"]

Möglichkeit 1 - Referenzen

Es wird das Bild als Referenz im Dokument definiert.

[Bild 1]: /pfad/zum/bild.png  "Beschreibung"

Im Text selbst kann dann auf das Bild referenziert werden.

![Irgendeine Beschreibung][Bild 1]

Möglichkeit 2 - Bilder direkt einbinden

Das Bild lässt sich auch direkt sofort in den Text einfügen

![Irgendeine Beschreibung](/pfad/zum/bild.png)

Möglichkeit 3 - Verwendung von HTML

Eine flexiblere Möglichkeit Bilder in den Text einzufügen, ist die Verwendung von HTML. Damit lassen sich auch einfache andere Attribute für das Bild einstellen, wie Höhe, Breite, etc.

<img src="pfad/zum/bild.png" width="250" height="350" alt="Irgendeine Beschreibung">

Beim referenzieren auf das Bild ist davor kein / zu verwenden!

Möglichkeit 4: Badges von Shields.io

Badges lassen sich mit Hilfe des kostenloses Webdienstes shields.io sehr einfach in eine Markdown-Datei einfügen. Es lassen sich statische und dynamische Badges direkt über die offizielle Webpräsenz erstellen.

🔗 https://shields.io/

[![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/donate?hosted_button_id=xxxxxxxxx) 

Tastaturtasten und andere Symbole

Mit Hilfe von HTML lassen sich in Markdown sehr einfach Symbole einfügen.

<kbd>Strg</kbd>+<kbd>&#8679;</kbd>
<kbd>Strg</kbd>+<kbd>&#11013;</kbd>
<kbd>Strg</kbd>+<kbd>&#127183;</kbd>
<kbd>Strg</kbd>+<kbd>&#11013;</kbd>
<kbd>Strg</kbd>+<kbd>&#8984;</kbd>

Strg+

Strg+

Strg+🃏

Strg+

Alle verfügbaren Symbole und deren Kodierung ist auf w3schools.com verfügbar

Emojis

Es gibt eine große Zahl an Emojis, die in Markdown-Dokumente eingefügt werden können.

ACHTUNG:

:warning: __ACHTUNG:__

😀 😄 🤣 😉

:grinning: :smile: :rofl: :wink:

Auf GitHub finden sich einige gute Emoji-Cheat-Sheets

Für Visual Studio Code gibt es die Erweiterung :emojisense. Beim Einfügen eines : in das Dokument wird ein Dropdown eingeblendet und das entsprechende Emoji kann ausgewählt werden.

Machs farbig

Bring mehr rote Farbe in deinen Text.
Bring mehr blaue Farbe in deinen Text.
Bring mehr grüne Farbe in deinen Text.
Bring mehr gelb Farbe in deinen Text.

Bring mehr <span style="color:red">rote</span> Farbe in deinen Text.  
Bring mehr <span style="color:blue">blaue</span> Farbe in deinen Text.  
Bring mehr <span style="color:green">grüne</span> Farbe in deinen Text.
Bring mehr <span style="color:yellow">gelb</span> Farbe in deinen Text.

Es gibt auch fetten farbigen Text Rot ist fett in einem normalen Text.

<span style="color:red">**Rot ist fett**</span> in einem normalen Text.

Der farbige Text wird in Gitea nicht dargestellt. Im Webbrowser Firefox mit der Erweiterung "Markdown Viewer Webext" oder einem Markdown-Editor (Typora, VS Studio, etc.) wird die Farbe dagegen korrekt angezeigt.

Schriftgröße und -art ändern

Die Maßeinheit em wird im Schriftsatz zur Bestimmung der Zeichenbreite in Abhängigkeit von der Schriftgröße verwendet.
(Quelle: https://de.wikipedia.org/wiki/Em_(Schriftsatz))

Schrift vergrößern

  • 2em Verdoppelt die Schriftgröße
  • 4em vervierfacht die Schriftgröße

Das ist normaler Text der auf einmal ganz groß wird.

Das ist normaler Text der auf einmal ganz <span style="font-family:Tahoma; font-size:4em;">groß</span> wird.

oder

Das ist normaler Text der auf einmal ganz groß

Das ist normaler Text der auf einmal ganz <font size="6">groß</font>

Schrift verkleinern

Das Gleiche geht natürlich auch in die andere Richtung, die Schriftgröße lässt sich verkleinern.

Das ist normaler Text der auf einmal ganz ganz klein wird.

Das ist normaler Text der auf einmal ganz <span style="font-family:Tahoma; font-size:0.5em;">ganz klein</span> wird.

oder

Das ist normaler Text der auf einmal ganz klein wird.

Das ist normaler Text der auf einmal ganz <font size="0.5">klein</font> wird.
``

## Tabellen

Tabellen lassen sich sehr einfach schreiben.
Mit ` | ` lassen sich die Spalten und Felder kennzeichnen, mit `:` definiert man die Textausrichtung.  
Wie auch schon bei anderen Sprachen, z.B. LaTeX und HTML, ist das manuelle Erstellen von Tabellen sehr umständlich, [Editoren](#editoren) bieten jedoch eine gute Unterstützung.

| Spaltenüberschrift 1 | Spaltenüberschrift 2 |  Spaltenüberschrift 3 |
|:-----------|:-----------:| -----------:|
| Inhalt align=left  | Inhalt align=center | Inhalt align=right |
| Inhalt | Inhalt | Inhalt |
| Inhalt | Inhalt | Inhalt |
| Inhalt | Inhalt | Inhalt |

```markdown
| Spaltenüberschrift 1 | Spaltenüberschrift 2 |  Spaltenüberschrift 3 |  
|:-----------|:-----------:| -----------:| 
| Inhalt align=left  | Inhalt align=center | Inhalt align=right |
| Inhalt | Inhalt | Inhalt |
| Inhalt | Inhalt | Inhalt |
| Inhalt | Inhalt | Inhalt |

Fußnoten

Ein Text mit einer Fußnote.1

Ein Text mit einer Fußnote.[^1]
[^1]: Der Text wird automatisch am Seitenende platziert.

Mathematische Formeln

Auch Markdown beherrscht mathematische Formeln, die aus TeX entliehen sind.

Vorlagen für LaTeX Formeln findet ihr im Blog ...

🔗 https://strobelstefan.org/2008/03/22/latex-vorlagen/

... oder auf Codeberg

🔗 https://codeberg.org/strobelstefan.org/latex-templates


Kaffeespende

Du findest meine Vorlage hilfreich, dann kannst du mir gerne einen Kaffee ausgeben.

😊 😎 bc1qfuz93hw2fhdvfuxf6mlxlk8zdadvnktppkzqzj 😄

Follow Me

🕊 Twitter🐘 MastodonRSS



  1. Der Text wird automatisch am Seitenende platziert.