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:
- Fett (strong): Dies ist fett gedruckter Text.
- Kursiv (emphasis): Dies ist kursiver Text.
Monospaced:Dies istmonospaced/codeText.- Fett und kursiv: Dies ist fett und kursiv zugleich.
- Hochgestellt: H2O (Subscript) und E=mc2 (Superscript).
- Durchgestrichen: dieser Text ist durchgestrichen.
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)
- Erster Punkt: Mit fettem Label und normalem Text dahinter.
- Zweiter Punkt: Noch ein Eintrag mit kursivem Text.
- Dritter Punkt: Ein Eintrag mit
codeund einem Link. - Vierter Punkt ohne fettes Label — nur normaler Text.
Ungeordnete Liste (Unordered List)
- Einfacher Listenpunkt
- Listenpunkt mit fetter Hervorhebung
- Listenpunkt mit kursiver Hervorhebung
- Listenpunkt mit
monospacedText
Verschachtelte Liste
- Hauptpunkt 1
- Unterpunkt 1a
- Unterpunkt 1b
- Hauptpunkt 2
- Unterpunkt 2a
- Unter-Unterpunkt 2a-i
- Unterpunkt 2b
- Unterpunkt 2a
Admonitions (Info-Boxen)
TIP mit Custom-Titel
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
Dies ist ein Tipp ohne expliziten Titel. Der Default-Titel "Praxis-Tipp" sollte erscheinen.
WARNING mit Custom-Titel
Dies ist eine Warnung mit benutzerdefiniertem Titel. Achtung vor diesem typischen Fehler!
WARNING mit Default-Titel
Dies ist eine Warnung ohne expliziten Titel. Der Default-Titel "Achtung" sollte erscheinen.
NOTE
Dies ist ein Hinweis. Er verwendet das Info-Icon und den Default-Titel "Hinweis".
IMPORTANT
Dies ist eine wichtige Information. Sie verwendet den Default-Titel "Wichtig".
Code-Bloecke
YAML mit Syntax-Highlighting
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
{
"status": "success",
"data": {
"apis": 1247,
"compliant": 1189,
"score": 95.3
}
}Code-Block ohne Sprache
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 2025Zitat nur mit Attribution
Dokumentation ist wie ein Witz: Wenn man sie erklaeren muss, ist sie nicht gut.
— Unbekannter EntwicklerZitat ohne Attribution
Ein einfaches Zitat ohne Quellenangabe. Sollte als Pull-Quote ohne Cite-Element gerendert werden.
Bilder
Platzhalter-Bild (mit .placeholder Rolle)
Zweites Platzhalter-Bild
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 |
Tabelle mit Footer
| 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
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
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 Express-Framework importieren
- 2 App-Instanz erzeugen
- 3 JSON-Body-Parser aktivieren
- 4 Health-Check Endpoint definieren
- 5 Server auf Port 3000 starten
YAML mit Callouts
linting:
enabled: true (2)
rules: "spectral-default" (3)
versioning:
strategy: "semver" (4)
- 1 Root-Konfiguration fuer API Governance
- 2 Automatisches Linting aktivieren
- 3 Spectral-Regelwerk verwenden
- 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