Tutorials

So fügen Sie Code-Blöcke in Confluence hinzu: Schritt-für-Schritt-Anleitung

Melden

Hier ist ein ausführliches Tutorial, wie du Code-Blöcke in Confluence (Cloud und Data Center/Server) einfügst und optimal nutzt.

Code-Blöcke sind essenziell für die Dokumentation von Softwareprojekten, Skripten oder Konfigurationen. Sie sorgen dafür, dass der Code übersichtlich bleibt, Syntax-Highlighting erhält und leicht kopiert werden kann.

Methode 1: Der schnellste Weg (Slash-Befehl)

In der modernen Confluence-Cloud-Version ist dies die effizienteste Methode.

  1. Setze den Cursor an die Stelle im Editor, an der der Code erscheinen soll.
  2. Tippe /code ein.
  3. Drücke die Eingabetaste (Enter).
  4. Ein leerer Code-Block erscheint sofort.

Methode 2: Über das Plus-Icon (Toolbar)

Wenn du lieber mit der Maus arbeitest:

  1. Klicke oben in der Editor-Werkzeugleiste auf das + (Einfügen) Symbol.
  2. Suche in der Liste nach Code-Snippet (oder klicke auf "Mehr anzeigen", falls es nicht sofort sichtbar ist).
  3. Wähle das Makro aus, um es einzufügen.

Methode 3: Markdown-Shortcut

Für Tastatur-Fans bietet Confluence eine automatische Formatierung:

  1. Tippe drei Backticks ( ` ) hintereinander ein.
  2. Drücke die Leertaste oder Enter.
  3. Confluence wandelt diese Zeichen automatisch in einen Code-Block um.

Den Code-Block konfigurieren

Sobald der Code-Block eingefügt wurde, kannst du ihn anpassen:

1. Programmiersprache festlegen (Syntax Highlighting)

Klicke auf den Code-Block. In der unteren oder oberen Menüleiste des Blocks kannst du die Sprache auswählen (z. B. Java, Python, JavaScript, XML, SQL). Confluence färbt den Code dann entsprechend der Syntax ein.

2. Zeilennummern aktivieren

In den Einstellungen des Blocks (meist über ein Zahnrad-Icon oder im schwebenden Menü) kannst du die Option Zeilennummern anzeigen aktivieren, um die Lesbarkeit bei längeren Skripten zu verbessern.

3. Titel vergeben

Du kannst dem Code-Block optional einen Namen geben (z. B. config.yaml), damit die Leser sofort wissen, worum es sich handelt.

4. Code kopieren

Für Leser der Seite erscheint oben rechts im Code-Block automatisch ein Kopieren-Symbol, sobald sie mit der Maus darüberfahren. Das macht es sehr einfach, den Code in die eigene Zwischenablage zu übernehmen.

Besonderheiten bei Confluence Server / Data Center (Legacy Editor)

Falls du eine ältere Version von Confluence nutzt, funktioniert es über Makros:

  1. Klicke auf Einfügen > Makros.
  2. Suche nach dem Makro Code-Block.
  3. Im Konfigurationsfenster kannst du die Sprache, das Theme (z. B. "Midnight" oder "Eclipse") und Zeilennummern festlegen.
  4. Klicke auf Einfügen und schreibe deinen Code in das Feld zwischen den Makro-Klammern.

Profi-Tipps

  • Kollabieren: Bei sehr langen Code-Abschnitten kannst du den Block in den Einstellungen als "Einklappbar" (Collapsible) markieren, damit er die Seite nicht unnötig in die Länge zieht.
  • Keine Formatierung: Wenn du nur einen kurzen Textabschnitt innerhalb eines Satzes als Code markieren willst (z. B. einen Variablennamen), markiere den Text und drücke Strg + Umschalt + M (Windows) oder Cmd + Umschalt + M (Mac).

Viel Erfolg beim Dokumentieren!

0