Der steps-Container verwandelt aufeinanderfolgende Anweisungen in nummerierte vertikale Zeitleisten mit Hover-Permalinks. Er ist für technische Tutorials und Schritt-für-Schritt-Anleitungen konzipiert.

Container-Syntax

::: steps # Äußerer sequentieller Zeitleisten-Container Öffner
::: step [title:"Schritt-Überschrift"] # Einzelner Schritt Öffner
Inhalt für Schritt 1 (Markdown-Text, Code-Blöcke, Hinweisfelder, Bilder)...
::: /step # Expliziter Schritt-Schließer

::: step [title:"Schritt 2 Überschrift"] # Zweiter Schritt Öffner
Inhalt für Schritt 2...
::: /step
::: /steps # Expliziter Zeitleisten-Schließer

Funktionen & Unterstützte Attribute

Parameter / Element Typ Beschreibung
Schritt-Titel "String" | title:"..." Überschriftentext am Kopf jedes Zeitleistenknotens (1. Parameter oder title:"...").
Zeitleistenknoten Automatisch Jeder ::: step-Block inkrementiert den Schrittindex automatisch (1, 2, 3…).
Sub-Container ::: step … ::: /step Explizite Schritt-Wrapper. Alte Listen-Syntax (1., 2.) wird ebenfalls unterstützt.
Schließ-Tags ::: /steps, ::: /step, ::: Unterstützt benannte Schließ-Tags oder generische :::-Schließer.
v0.9.1+ Standardisierung der Container-Syntax

Ab v0.9.1 führt docmd explizite Öffnungs- und Schließungs-Container-Tags (z.B. ::: card … ::: /card, ::: tab … ::: /tab), explizite Key-Value-Eigenschaften (title:"...", url:"...") und nachfolgende # Kommentare ein. Diese modernisierte Syntax wird für alle neuen Dokumentationen empfohlen. Die vollständige Abwärtskompatibilität für alte Sub-Block-Marker (== tab, 1.) und Positionsparameter bleibt strikt erhalten.

Anwendungsbeispiele

Grundlegende Workflow-Sequenz

Eine einfache Sequenz für Developer-Onboarding-Aufgaben mit expliziten ::: step-Containern:

::: steps # Onboarding-Workflow
::: step "Projekt initialisieren" # Schritt 1
Führen Sie `npx @docmd/core init` aus, um Ihre Verzeichnisstruktur zu erstellen.
::: /step

::: step "Inhalte verfassen" # Schritt 2
Schreiben Sie Dokumentationen in Standard-Markdown-Dateien.
::: /step

::: step "Bauen & Bereitstellen" # Schritt 3
Führen Sie `npx @docmd/core build` aus, um die Produktionsausgabe zu kompilieren.
::: /step
::: /steps
  1. Projekt initialisieren

    Führen Sie npx @docmd/core init aus, um Ihre Verzeichnisstruktur zu erstellen.

  2. Inhalte verfassen

    Schreiben Sie Dokumentationen in Standard-Markdown-Dateien.

  3. Bauen & Bereitstellen

    Führen Sie npx @docmd/core build aus, um die Produktionsausgabe zu kompilieren.

Schritte mit eingebettetem Content

Schritte unterstützen eingebettete Code-Blöcke, Hinweisfelder (Callouts) und verschachtelte Container:

::: steps # Komplexer Bereitstellungsleitfaden
::: step "Umgebung konfigurieren"
Definieren Sie Optionen in `docmd.config.json`.

::: callout info title:"IDE-Hinweis"
Verwenden Sie `defineConfig`, um die IDE-Autovervollständigung für Konfigurationsschlüssel zu aktivieren.
::: /callout
::: /step

::: step "Produktions-Build generieren"
Führen Sie den Build-Befehl aus, um eine optimierte statische Website zu generieren.

```bash
npx @docmd/core build
```
::: /step

::: step "Auf Infrastruktur bereitstellen"
Veröffentlichen Sie das kompilierte `site/`-Verzeichnis auf S3, Cloudflare Pages oder Vercel.
::: /step
::: /steps
  1. Umgebung konfigurieren

    Definieren Sie Optionen in docmd.config.json.

    IDE-Hinweis

    Verwenden Sie defineConfig, um die IDE-Autovervollständigung für Konfigurationsschlüssel zu aktivieren.

  2. Produktions-Build generieren

    Führen Sie den Build-Befehl aus, um eine optimierte statische Website zu generieren.

    npx @docmd/core build
  3. Auf Infrastruktur bereitstellen

    Veröffentlichen Sie das kompilierte site/-Verzeichnis auf S3, Cloudflare Pages oder Vercel.

Legacy-Listen-Syntax

Bestehende Dokumentationen mit geordneten Listen (1., 2.) werden weiterhin nahtlos verarbeitet:

::: steps
1.  **Umgebung konfigurieren**
    Definieren Sie Optionen in `docmd.config.json`.
::: /steps
Vorherige Tabs Nächste Einklappbar