Markdown-Beispiele
Häufige Authoring-Snippets
Code#
export function greet(name: string) {
return `Hallo, ${name}!`
}
Einzelne Zeilen kannst du per Fence-Meta ({2}) oder Inline-Notation markieren:
export function greet(name: string) {
return `Hallo, ${name}!`;
}
Inline-Code wie themeConfig.outline verwendet dieselben Theme-Tokens wie Codeblöcke.
Snippet-Import#
Wiederverwende Quelldateien statt Code zu duplizieren:
export function greet(name: string) {
return `Hello, ${name}!`;
}
Das @/-Präfix wird relativ zum Content-Root (srcDir) aufgelöst.
Links#
Tabellen#
| Syntax | Ergebnis |
|---|---|
# Titel |
Überschrift |
--- Frontmatter |
Seitenmetadaten |
Zitate#
Nutze Blockquotes für Callouts, Hinweise oder kurze Kontextinformationen.
Container#
TIP
::: tip, ::: warning, ::: danger, ::: info und ::: details funktionieren wie bei VitePress.
Eigener Titel
Optional kannst du nach dem Typ einen eigenen Titel angeben.
GFM-Alerts#
GitHub-Alert-Syntax wird wie die Custom Container gerendert:
NOTE
Nützliche Informationen für Leserinnen und Leser.
TIP
Optionale Tipps für bessere Ergebnisse.
WARNING
Kritische Inhalte, die sofortige Aufmerksamkeit brauchen.
Heading-IDs#
Eigene Anker#
Mit {#deine-id} steuerst du die Fragment-URL.
Inline-Inhaltsverzeichnis#
Erster Abschnitt#
Inhalt des ersten Abschnitts.
Zweiter Abschnitt#
Inhalt des zweiten Abschnitts.
Code-Gruppen#
npm install
pnpm install
Eigene Heading-IDs#
Stabile Links#
Hänge {#id} an eine Überschrift, um den Anker zu steuern.
Emoji#
:tada: und :rocket: funktionieren standardmäßig.
Inline-Inhaltsverzeichnis#
Zweiter Abschnitt#
Inhalt unter dem inline TOC.
Unterabschnitt#
Verschachtelte Überschrift für die Gliederung.
Code-Gruppen#
export default { lang: "js" };
export default { lang: "ts" };