Markdown-Syntax

PeepMD stellt GitHub Flavored Markdown dar (CommonMark plus die GFM-Erweiterungen), mit ein paar Ergänzungen aus Bear und Lettera. Alles auf dieser Seite stellt dieselbe Engine dar, die auch deine Dokumente darstellt, und jedes Beispiel zeigt zuerst das Markdown und dann, wie es aussieht.

Auszeichnungen im Text

Syntax	Ergebnis
**fett**	fett
*kursiv*	kursiv
~~durchgestrichen~~	durchgestrichen
`Inline-Code`	Inline-Code
[Link](https://example.com)	Link
Fußnote[^2]	Fußnote1

Typografische Satzzeichen sind eingeschaltet: Gerade Anführungszeichen werden zu "geschwungenen", und Bindestriche--wie diese--werden zu Halbgeviert- und Geviertstrichen.

Fußnoten

Eine Fußnote hat zwei Teile: den Verweis in deinem Text und die Definition, die irgendwo im Dokument stehen kann:

Die Behauptung, die eine Quelle braucht.[^1]

[^1]: Der Text der Fußnote. Er sammelt sich am Ende
    des Dokuments, mit einem Pfeil zurück zum Verweis.

wird zu: Die Behauptung, die eine Quelle braucht.²

Bezeichnungen wie [^1] sind frei wählbar, du kannst sie also beliebig benennen. Die angezeigten Nummern werden nach der Reihenfolge im Dokument vergeben, darum erscheint das [^2] in der Tabelle oben mit einer anderen Nummer.

Listen

- ein Aufzählungspunkt
- noch einer
    - durch Einrücken verschachtelt

1. ein nummerierter Punkt
2. der nächste

- [x] eine erledigte Aufgabe
- [ ] eine offene

wird zu:

Klicke oder tippe auf das Kästchen einer Aufgabe, und PeepMD schreibt das Häkchen in die Datei, diese eine Zeile und sonst nichts. Die Kästchen funktionieren in jedem Dokument, in das du schreiben darfst, und bleiben in Exporten, wie sie sind.

Tabellen

Senkrechte Striche bilden Spalten; die zweite Zeile legt mit Doppelpunkten die Ausrichtung fest:

| Links | Zentriert | Rechts |
| :--- | :---: | ---: |
| ada | 1815 | £300 |
| grace | 1906 | $10 |

wird zu:

Hervorhebungen und Unterstreichung

Zwei Ergänzungen über GFM hinaus, geschrieben wie in Bear und Lettera:

• ==Text== wird zu einer Hervorhebung, gut, um das Entscheidende zu markieren.
• ~Text~ (einfache Tilden) wird zu einer Unterstreichung. Doppelte Tilden bleiben Durchstreichung.

Beides lässt sich mit anderen Auszeichnungen kombinieren: fett mit einer Hervorhebung darin.

Wiki-Links

Links zwischen Notizen, geschrieben wie in Obsidian, mit dem Namen der Notiz statt ihres Pfads:

Syntax	Ergebnis
[[Hilfe - Stile]]	Hilfe - Stile
[[Hilfe - Stile|ein Linktext]]	ein Linktext
[[Hilfe - Stile#Eigene hinzufügen]]	Hilfe - Stile#Eigene hinzufügen
[[#Hinweiskästen]]	#Hinweiskästen
[[Noch nicht geschrieben]]	Noch nicht geschrieben

Der Name wird im ganzen Vault gesucht, sodass eine Notiz gefunden wird, wo immer sie liegt: Ein Link in Inbox/Today.md erreicht Projects/Plan.md als [[Plan]]. Der Vault ist der Ordner, den Obsidian als solchen markiert hat, oder sonst der umfassendste Ordner, den PeepMD lesen darf. Teilen sich zwei Notizen einen Namen, gewinnt die neben dem Dokument, und [[Projects/Plan]] sagt, welche du meinst. Eine Notiz, die es noch nicht gibt, erscheint blass, wie in der letzten Zeile.

![[photo.png]] bettet ein Bild von irgendwo im Vault ein, und ![[photo.png|300]] legt seine Breite fest.

Hinweiskästen

Ein Zitatblock, der mit einer Markierung beginnt, wird zu einem gestalteten Hinweiskasten:

> [!NOTE]
> Nützliche Information, die man auch beim Überfliegen sehen sollte.

> [!TIP] Ein Titel in der Zeile der Markierung funktioniert auch.
> Das ist die Schreibweise von Bear und Lettera.

wird zu:

Alle fünf Arten von GitHub werden dargestellt. Die anderen drei:

Ein gewöhnlicher Zitatblock bleibt ein gewöhnlicher Zitatblock:

---

Zurück: Dokumente lesen · Inhalt · Weiter: Code und Diagramme

1. Hier ist die aus der Tabelle oben. ↩

2. Der Text der Fußnote. Er sammelt sich am Ende des Dokuments, mit einem Pfeil zurück zum Verweis. ↩