Dies ist ein Absatz mit der Klasse drop-cap und einer expliziten ID. Der erste Buchstabe sollte gross und dekorativ dargestellt werden — genau wie im Governance-Artikel. Dieser Absatz testet das paragraph.njk-Template mit Rolle und ID.

Ein normaler Absatz ohne besondere Attribute. Er enthaelt fetten Text, kursiven Text und monospaced Text. Ausserdem einen Link zu einer externen Seite.

Ein weiterer Absatz, um sicherzustellen, dass mehrere aufeinanderfolgende Absaetze korrekt gerendert werden, ohne unerwuenschte Wrapper oder zusaetzliche Abstande.

Inline-Formatierung

Dieser Abschnitt testet alle Inline-Formatierungen:

Ueberschriften-Hierarchie

Dieser Abschnitt testet die Ueberschriften-Hierarchie. Die <h2> oben hat eine explizite ID (section-3), die h3/h4 darunter sollten keine auto-generierten IDs haben.

Ueberschrift Ebene 3 (h3)

Text unter einer h3-Ueberschrift.

Ueberschrift Ebene 4 (h4)

Text unter einer h4-Ueberschrift. Diese Ebene wird seltener benutzt, muss aber trotzdem korrekt rendern.

Ueberschrift Ebene 5 (h5)

Text unter einer h5-Ueberschrift. Wird fuer feingliedrige Untergliederungen verwendet.

Ueberschrift Ebene 6 (h6)

Text unter einer h6-Ueberschrift. Die kleinste Ueberschriftenebene — uppercase mit Letter-Spacing, um sie visuell von normalem Body-Text abzuheben.

Listen

Geordnete Liste (Ordered List)

  1. Erster Punkt: Mit fettem Label und normalem Text dahinter.
  2. Zweiter Punkt: Noch ein Eintrag mit kursivem Text.
  3. Dritter Punkt: Ein Eintrag mit code und einem Link.
  4. Vierter Punkt ohne fettes Label — nur normaler Text.

Ungeordnete Liste (Unordered List)

Verschachtelte Liste

Admonitions (Info-Boxen)

TIP mit Custom-Titel

Praxis-Empfehlung

Dies ist ein Tipp mit benutzerdefiniertem Titel. Der Titel kommt aus der AsciiDoc .Title-Syntax und ueberschreibt den Default "Praxis-Tipp".

TIP mit Default-Titel

Praxis-Tipp

Dies ist ein Tipp ohne expliziten Titel. Der Default-Titel "Praxis-Tipp" sollte erscheinen.

WARNING mit Custom-Titel

Haeufiger Fehler

Dies ist eine Warnung mit benutzerdefiniertem Titel. Achtung vor diesem typischen Fehler!

WARNING mit Default-Titel

Achtung

Dies ist eine Warnung ohne expliziten Titel. Der Default-Titel "Achtung" sollte erscheinen.

NOTE

Hinweis

Dies ist ein Hinweis. Er verwendet das Info-Icon und den Default-Titel "Hinweis".

IMPORTANT

Wichtig

Dies ist eine wichtige Information. Sie verwendet den Default-Titel "Wichtig".

Code-Bloecke

YAML mit Syntax-Highlighting

example-config.yaml
# Kommentar — sollte als .comment gerendert werden
server:
  host: "localhost"
  port: 8080
  ssl:
    enabled: true
    certificate: "/path/to/cert.pem"


database:
  driver: "postgresql"
  connection-string: "postgres://user:pass@localhost:5432/mydb"
  pool-size: 10

JSON Code-Block

example-response.json
{
  "status": "success",
  "data": {
    "apis": 1247,
    "compliant": 1189,
    "score": 95.3
  }
}

Code-Block ohne Sprache

Einfacher Textblock
Dies ist ein Code-Block ohne Sprachangabe.
Er sollte als plain text gerendert werden.

Zitate (Pull-Quotes)

Zitat mit Attribution und Citetitle

API Governance ist keine Bremse fuer Innovation — sie ist die Leitplanke, die es Teams erlaubt, mit voller Geschwindigkeit zu fahren.

— Dr. Lukas Schreiber, API Portal Summit 2025

Zitat nur mit Attribution

Dokumentation ist wie ein Witz: Wenn man sie erklaeren muss, ist sie nicht gut.

— Unbekannter Entwickler

Zitat ohne Attribution

Ein einfaches Zitat ohne Quellenangabe. Sollte als Pull-Quote ohne Cite-Element gerendert werden.

Bilder

Platzhalter-Bild (mit .placeholder Rolle)

API Lifecycle Dashboard — Screenshot
Abb. 1: API Lifecycle Dashboard — eine Platzhalter-Abbildung mit SVG-Icon und Figcaption.

Zweites Platzhalter-Bild

Governance Scorecard Ansicht
Abb. 2: Governance Scorecard — zeigt den Compliance-Score pro API.

Tabellen

Einfache Tabelle

Feature Beschreibung Status
API Katalog Zentrale Uebersicht aller APIs mit Suchfunktion Aktiv
API Linter Automatische Pruefung gegen Style Guide Aktiv
Versionsvergleich Diff-Ansicht zwischen API-Versionen Beta
Workflow Design Visueller Editor fuer Genehmigungsprozesse Geplant

Tabelle ohne Header

Zeile 1, Spalte 1 Zeile 1, Spalte 2 Zeile 1, Spalte 3
Zeile 2, Spalte 1 Zeile 2, Spalte 2 Zeile 2, Spalte 3
Komponente Aufwand Status
AsciiDoc Templates Hoch Fertig
CSS Styles Mittel Fertig
Gesamt 2/2 erledigt

CSV-Tabelle (Shorthand)

Methode Endpoint Beschreibung
GET /api/v1/users Alle Benutzer auflisten
POST /api/v1/users Neuen Benutzer anlegen
DELETE /api/v1/users/:id Benutzer loeschen

DSV-Tabelle (Doppelpunkt-Trenner)

Protokoll Port Verschluesselung
HTTP 80 Nein
HTTPS 443 TLS 1.3
gRPC 50051 Optional

Custom Macros

stat-callout Block-Macro

1.200+
APIs pro Enterprise
30%
jaehrliches Wachstum
73%
ohne Governance

article Cross-Reference Inline-Macro

Einfacher Link: API Definition Artikel.

Link mit Anchor: Swagger Grundlagen.

Link mit Title-Attribut: API Definition Guide.

Link mit Anchor + Title: Swagger im Detail.

Unbekannte pageId (Error-Log testen): Dieser Link existiert nicht.

Callouts (Code-Annotationen)

Code-Callouts erlauben nummerierte Annotationen direkt im Quellcode, die unter dem Code-Block erklaert werden.

JavaScript mit Callouts

javascript
import express from 'express'; // <1>

const app = express(); // <2>
app.use(express.json()); // <3>

app.get('/api/health', (req, res) => { // <4>
  res.json({ status: 'ok', timestamp: Date.now() });
});

app.listen(3000, () => { // <5>
  console.log('Server laeuft auf Port 3000');
});
  1. 1 Express-Framework importieren
  2. 2 App-Instanz erzeugen
  3. 3 JSON-Body-Parser aktivieren
  4. 4 Health-Check Endpoint definieren
  5. 5 Server auf Port 3000 starten

YAML mit Callouts

yaml
api-governance: (1)
  linting:
    enabled: true (2)
    rules: "spectral-default" (3)
  versioning:
    strategy: "semver" (4)
  1. 1 Root-Konfiguration fuer API Governance
  2. 2 Automatisches Linting aktivieren
  3. 3 Spectral-Regelwerk verwenden
  4. 4 Semantische Versionierung als Strategie

Fussnoten

Fussnoten eignen sich fuer Quellenangaben und ergaenzende Informationen, die den Lesefluss nicht stoeren sollen.

API Governance ist ein systematischer Ansatz zur Steuerung von APIs.[1] Die fuenf Saeulen umfassen Design, Security, Lifecycle, Monitoring und Documentation.[2]

Eine benannte Fussnote kann mehrfach referenziert werden.[3] Spaeter im Text kann man die gleiche Quelle erneut zitieren.[3]

Zeilenumbrueche

Einzelne Zeilenumbrueche mit

Zeile eins mit explizitem Umbruch,
Zeile zwei folgt direkt darunter,
und Zeile drei schliesst den Absatz.

Block-Attribut hardbreaks

Dr. Lukas Schreiber
API Portal GmbH
Musterstrasse 42
10115 Berlin
Deutschland