Skip to main content

Links and anchors

TargetSyntaxResult
Page in the same area[Code blocks](./codebloecke.md)Code blocks
Section of another page[Line numbers](./codebloecke.md#line-numbers)Line numbers
Section of this page[Twig blocks](#twig-bloecke)Twig blocks
Page in the user guide[Tables](../user/tabellen.md)Tables
Section in the user guide[FAQ](../user/lange-anleitung.md#faq)FAQ
External page[Shopware docs](https://developer.shopware.com/)Shopware docs

Always link to the .md file, not to the later URL. The build checks all links and anchors and fails on a broken link.

Automatic anchors​

Every heading automatically gets an anchor from its text: lower case, spaces become hyphens, umlauts are kept.

HeadingAnchor
## Highlighting lines#highlighting-lines
## Häufige Fragen#häufige-fragen
## Data model (ER diagram)#data-model-er-diagram

Fixed anchors​

Automatic anchors change when the heading is reworded, and they differ between DE and EN. For sections that are linked to, write a fixed anchor after the heading:

## Frequently asked questions \{#faq}

Use the same fixed anchor in DE and EN – then links work the same in both languages.

note

On GitHub, {#faq} appears as text after the heading. In the portal it is invisible.

Twig blocks​

Example section that the long guide in the user guide links to.

BlockTemplate
gb_noticestorefront/page/product-detail/buy-widget.html.twig
gb_notice_textstorefront/component/gb-notice.html.twig

Collapsible sections​

Source of a collapsible section
<details>
<summary>Title</summary>

Content with **Markdown**. Don't forget the blank lines after summary and before the end.

</details>