Skip to main content

Text formatting

This page shows the basic text markup. Everything here is standard Markdown (GFM) and also renders correctly on GitHub.

Emphasis​

  • Bold for controls and admin paths: Save
  • Italic for terms being introduced: a notice is a short text on the product page
  • Bold and italic – use sparingly
  • Strikethrough for information that no longer applies
  • Inline code for values entered exactly as shown: Delivery within Germany only
  • Keyboard shortcuts: Ctrl + S saves, Esc closes the dialog

Headings​

Level 2 and 3 headings appear in the “On this page” table of contents on the right. The page itself has exactly one level 1 heading – it is the page title.

Level 3 heading​

Text below a level 3 heading.

Level 4 heading​

Level 4 does not appear in the table of contents by default. The long guide shows how to change that.

Paragraphs and line breaks​

A blank line starts a new paragraph. A single line break in the source is joined – these two lines appear as one paragraph.

To force a break within a paragraph, end the line with a backslash:
this line starts anew but belongs to the same paragraph.

Quotes​

A quote suits literal messages, e.g. texts the shop displays.

Message in the shop: “This item ships within Germany only.”

Quotes can be nested, too.

Horizontal rule​

A horizontal rule visually separates long sections:


Text after the rule.

Footnotes​

Footnotes suit side remarks1 that should not interrupt the flow. They are collected at the end of the page2.

Special characters​

Typographic characters work directly: “quotation marks”, en dash –, arrow →, ellipsis …, degrees 20 °C, euro €19.99.

Characters with special meaning are escaped with a backslash: *not italic*, # not a heading.

Curly and angle brackets

The portal processes Markdown as MDX. A curly bracket or an angle bracket in running text causes a build error. Put such characters in inline code (e.g. {productId}, a < b) or escape them with a backslash: { and <.

Footnotes​

  1. This is the first footnote. ↩

  2. Footnotes can have a name instead of a number. ↩