Zum Inhalt springen

← Handbuch

Markdown-Referenz

markbird spricht GitHub-Flavored Markdown, dazu Diagramme, Formeln und Hinweisboxen. Eine einzige Render-Pipeline erzeugt die Live-Vorschau, jeden Export und die Freigabe-Ansicht — was du beim Schreiben siehst, bekommen alle anderen auch.

Die Grundlagen

# Überschrift 1

## Überschrift 2

**fett**, _kursiv_, ~~durchgestrichen~~, `Inline-Code`

- ein Punkt
- noch einer

1. nummerierte
2. Liste

> ein Zitat

[ein Link](https://markbird.md), ![ein Bild](/pfad.png)

Tabellen

| Funktion | Status |
| -------- | :----: |
| Tabellen |   ✓    |

Doppelpunkte in der Trennzeile setzen die Ausrichtung: :--- links, :---: zentriert, ---: rechts.

Aufgabenlisten

- [x] Erledigt
- [ ] Offen

Codeblöcke

Mit drei Backticks einzäunen und die Sprache angeben für Syntaxhervorhebung:

```ts
export const render = (md: string) => pipeline.process(md);
```

Enthält dein Code selbst eine Folge von Backticks, öffne den Zaun mit mehr Backticks als die längste Folge darin.

Mermaid-Diagramme

Verwende einen mermaid-Block:

```mermaid
graph TD
  A[Schreiben] --> B[Vorschau]
  B --> C[Export]
```

Diagramme werden in der Vorschau und in Exporten gerendert — auf deinem Gerät. An einen Diagrammdienst geht nichts.

Formeln mit KaTeX

Inline zwischen einfachen Dollarzeichen, abgesetzt zwischen doppelten:

Euler: $e^{i\pi} + 1 = 0$

$$
\int_0^1 x^2 \,dx = \tfrac{1}{3}
$$

KaTeX lädt nur für Dokumente, die tatsächlich Formeln enthalten — bei allen anderen kostet es nichts.

Fußnoten

Eine Behauptung, die Belege braucht.[^1]

[^1]: Der Beleg.

GitHub-Hinweise

> [!NOTE]
> Nützlicher Kontext.

> [!TIP]
> Ein besserer Weg.

> [!IMPORTANT]
> Nicht übersehen.

> [!WARNING]
> Vorsicht.

> [!CAUTION]
> Gefahr von Schäden.

Frontmatter

Ein ----Block ganz oben im Dokument ist Metadaten, kein Fließtext. markbird hält ihn aus der Vorschau und aus jedem Export heraus und nutzt ihn für Tags und Aliasse:

---
tags: [handbuch, markdown]
aliases: [Syntax-Referenz]
---

Was markbird damit macht, steht unter Wissensdatenbank.

[[Andere Notiz]] verlinkt Dokumente über den Titel. Das ist markbirds eigene Erweiterung von Markdown, beschrieben unter Wissensdatenbank.

HTML

Inline-HTML ist erlaubt, wird aber bereinigt: Skripte, Event-Handler und javascript:-URLs werden vor dem Rendern entfernt. Das gilt für Dokumente aus jeder Quelle — ein geteilter Link kann in deinem Browser also keinen Code ausführen.