Invoke-MarkdownDocBuild

ÜBERSICHT

Erstellt aus einer Markdown-Dokumentationsstruktur eine HTML-Dokumentation.

SYNTAX

Invoke-MarkdownDocBuild [-SourcePath] <string> [-TargetPath] <string> [[-NewDays] <int>]
    [<CommonParameters>]

BESCHREIBUNG

Die Funktion durchläuft rekursiv einen Quellordner mit Markdown-Dateien (*.md) und erzeugt im Zielordner eine identische Verzeichnisstruktur mit HTML-Dateien.

Die eigentliche Konvertierung erfolgt über Convert-MarkdownToHtml. Die Funktion übernimmt ausschließlich die Orchestrierung (Batch-Verarbeitung). Zusätzlich wird eine Indexseite (index.html) mit gruppierter Funktionsübersicht erzeugt.

PARAMETER

-SourcePath

Type: string

Wurzelverzeichnis der Markdown-Dokumentation.

-TargetPath

Type: string

Zielverzeichnis für die erzeugte HTML-Dokumentation.

-NewDays

Type: int
Default: 3

Maximale Anzahl Tage für das "N"-Badge (neu/kürzlich geändert). Die Berechnung erfolgt clientseitig per JavaScript, damit Badges auch ohne Rebuild nach und nach verschwinden. Das Script reduziert die Spanne dynamisch, damit höchstens 24 Funktionen markiert werden. Liefert eine kürzere Spanne 0 Treffer, bleibt die vorherige erhalten. Standard: 3.

BEISPIELE

# Markdown-Dokumentation nach HTML konvertieren
Invoke-MarkdownDocBuild `
  -SourcePath '.\source\docs-md' `
  -TargetPath '.\docs-html'