Links und Sprungmarken
Links auf andere Seiten
| Ziel | Schreibweise | Ergebnis |
|---|---|---|
| Seite im selben Bereich | [Codeblöcke](./codebloecke.md) | Codeblöcke |
| Abschnitt einer anderen Seite | [Zeilennummern](./codebloecke.md#zeilennummern) | Zeilennummern |
| Abschnitt dieser Seite | [Twig-Blöcke](#twig-bloecke) | Twig-Blöcke |
| Seite der Benutzer-Doku | [Tabellen](../user/tabellen.md) | Tabellen |
| Abschnitt der Benutzer-Doku | [FAQ](../user/lange-anleitung.md#faq) | FAQ |
| Externe Seite | [Shopware-Doku](https://developer.shopware.com/) | Shopware-Doku |
Links immer auf die .md-Datei setzen, nicht auf die spätere URL. Der Build prüft alle Links und Sprungmarken und bricht bei einem kaputten Link ab.
Automatische Sprungmarken
Jede Überschrift bekommt automatisch eine Sprungmarke aus ihrem Text: Kleinbuchstaben, Leerzeichen werden zu Bindestrichen, Umlaute bleiben erhalten.
| Überschrift | Sprungmarke |
|---|---|
## Zeilen hervorheben | #zeilen-hervorheben |
## Häufige Fragen | #häufige-fragen |
## Datenmodell (ER-Diagramm) | #datenmodell-er-diagramm |
Feste Sprungmarken
Automatische Sprungmarken ändern sich, wenn die Überschrift umformuliert wird, und sind in DE und EN verschieden. Für Abschnitte, auf die verlinkt wird, eine feste Sprungmarke hinter die Überschrift schreiben:
## Häufige Fragen \{#faq}
Dieselbe feste Sprungmarke in DE und EN verwenden – dann funktionieren Links in beiden Sprachen gleich.
Auf GitHub erscheint {#faq} als Text hinter der Überschrift. Im Portal ist es unsichtbar.
Twig-Blöcke
Beispiel-Abschnitt, auf den die Lange Anleitung aus der Benutzer-Doku verlinkt.
| Block | Template |
|---|---|
gb_notice | storefront/page/product-detail/buy-widget.html.twig |
gb_notice_text | storefront/component/gb-notice.html.twig |
Aufklappbare Abschnitte
Quelltext eines aufklappbaren Abschnitts
<details>
<summary>Titel</summary>
Inhalt mit **Markdown**. Leerzeilen nach summary und vor dem Ende nicht vergessen.
</details>