Zum Hauptinhalt springen

Textformatierung

Diese Seite zeigt die grundlegenden Textauszeichnungen. Alles hier ist Standard-Markdown (GFM) und wird auch auf GitHub korrekt dargestellt.

Hervorhebungen​

  • Fett für Bedienelemente und Admin-Pfade: Speichern
  • Kursiv für Begriffe, die eingeführt werden: ein Hinweis ist ein kurzer Text auf der Produktseite
  • Fett und kursiv sparsam einsetzen
  • Durchgestrichen für entfallene Angaben
  • Inline-Code für Werte, die genau so eingegeben werden: Lieferung nur innerhalb DE
  • Tastenkürzel: Strg + S speichert, Esc schließt den Dialog

Überschriften​

Überschriften der Ebene 2 und 3 erscheinen rechts im Inhaltsverzeichnis „Auf dieser Seite“. Die Seite selbst hat genau eine Überschrift der Ebene 1 – sie ist der Seitentitel.

Überschrift Ebene 3​

Text unter einer Überschrift der Ebene 3.

Überschrift Ebene 4​

Ebene 4 erscheint standardmäßig nicht im Inhaltsverzeichnis. Die Seite Lange Anleitung zeigt, wie man das ändert.

Absätze und Zeilenumbrüche​

Ein Absatz entsteht durch eine Leerzeile. Ein einfacher Zeilenumbruch im Quelltext wird zusammengezogen – diese beiden Zeilen erscheinen als ein Absatz.

Für einen erzwungenen Umbruch innerhalb eines Absatzes endet die Zeile mit einem Backslash:
diese Zeile beginnt neu, gehört aber zum selben Absatz.

Zitate​

Ein Zitat eignet sich für wörtliche Meldungen, z. B. Texte, die der Shop anzeigt.

Meldung im Shop: „Dieser Artikel wird nur innerhalb Deutschlands geliefert.“

Zitate lassen sich auch verschachteln.

Trennlinie​

Eine Trennlinie gliedert lange Abschnitte optisch:

Text nach der Trennlinie.

Fußnoten​

Fußnoten eignen sich für Randbemerkungen1, die den Lesefluss nicht stören sollen. Sie werden am Seitenende gesammelt2.

Sonderzeichen​

Typografische Zeichen funktionieren direkt: „deutsche Anführungszeichen“, Gedankenstrich –, Pfeil →, Ellipse …, Grad 20 °C, Euro 19,99 €.

Zeichen mit Sonderbedeutung werden mit Backslash geschützt: *kein kursiv*, # keine Überschrift.

Geschweifte und spitze Klammern

Das Portal verarbeitet Markdown als MDX. Eine geschweifte Klammer oder eine spitze Klammer im Fließtext führt zu einem Build-Fehler. Solche Zeichen gehören in Inline-Code (z. B. {productId}, a < b) oder werden mit Backslash geschützt: { und <.

Footnotes​

  1. Das ist die erste Fußnote. ↩

  2. Fußnoten können auch einen Namen statt einer Zahl haben. ↩