Skip to main content

Code in einem Absatz (Inline-Code)

Wenn Sie in einen Absatz statt eines vollständigen Codeblocks ein kleines Codefragment einfügen möchten, verwenden Sie ein Inline-Element. Für diesen Zweck bieten sich mehrere Elemente an, wobei code hier vielleicht am häufigsten genutzt wird.

Doch es gibt auch andere Elemente, die Sie verwenden können, z. B. command für Terminalbefehle. Daneben gibt es Elemente wie synopsis, cmdsynopsis, userinput, varname, replaceable, constant und viele mehr, über die Sie im Standard-Elementverzeichnis mehr erfahren können. Bitte gehen Sie bei der Auswahl von Elementen zur Kennzeichnung von Codebeispielen möglichst einheitlich vor.

So fügen Sie ein Codeelement (oder ein anderes Inline-Element) hinzu:

  1. Markieren Sie den Text, auf den Sie ein Element anwenden möchten.

    highlight.png

  2. Drücken Sie Alt + Enter ⏎ (Windows) oder Command ⌘ + Enter ⏎ (Mac), um den Kontextmenü „Elemente“ anzuzeigen.

    Element context menu shows a search field and a list of elements that are valid at the current position.

  3. Wählen Sie das gewünschte Element aus der Liste aus.

    Wählen Sie z. B. code aus.

  4. Geben Sie Ihren Code in das Element ein.

  5. Drücken Sie Speichern. Save icon.

Beispiel 1. Beispiel für Inline-Code

Angenommen, Sie möchten den Code ssh -1 username remote-address zu einem bestimmten Absatz hinzufügen. Dazu setzen Sie den Cursor an die entsprechende Stelle im para-Element und fügen dann das Inline-code-Element hinzu.

Sie tippen den Code ssh -1 username remote-address in das code-Element ein. Im veröffentlichten Dokument enthält der Absatz einen Mix aus normalem Text und Code, etwa wie folgt:

Um sich an einem anderen Gerät anzumelden, geben Sie den Benutzernamen ssh -l username remote-address ein und drücken Sie Enter.