Convert-MarkdownToHtml

EulandaXtools — Funktionsreferenz

Convert-MarkdownToHtml

ÜBERSICHT

Wandelt eine Markdown-Datei mit PowerShell-Dokumentationen in modernes, helles HTML um.

SYNTAX

Convert-MarkdownToHtml [-InputPath] <string> [-OutputPath] <string> [[-Title] <string>]
    [[-LastModified] <string>] [[-CanonicalUrl] <string>] [<CommonParameters>]

BESCHREIBUNG

Diese Funktion konvertiert eine umfangreiche Markdown-Datei, wie sie für EULANDA- oder CrossDataHub-PowerShell-Dokumentationen verwendet wird, in eine moderne HTML-Datei mit hellem, blautonigem Layout. Sie erkennt dabei wiederkehrende Funktionsblöcke (beginnend mit '# FunctionName') sowie deren interne Sektionen ('## ÜBERSICHT', '## SYNTAX', '## PARAMETER' usw.) und setzt diese in strukturierte HTML-Karten um.

Codeblöcke zwischen Markdown-Markern (``` … ```) werden erkannt, inklusive PowerShell-Kommentaren, und unverändert als

 dargestellt. Dritte Markdown-Ebenen ('### -ParameterName') werden innerhalb der Sektionen als dezente Unter-überschriften formatiert.

Das Ergebnis ist eine klare, lesbare Dokumentation mit Fließtext, Syntax-Blöcken und parametrischen Unterüberschriften, ideal für modulinterne Referenzen oder zum Export in statische HTML-Dokumentationen.

PARAMETER

-InputPath

Type: string

Vollständiger Pfad zur Markdown-Datei, die konvertiert werden soll.

-OutputPath

Type: string

Vollständiger Pfad, unter dem die HTML-Datei gespeichert werden soll.

-Title

Type: string
Default: "PowerShell Dokumentation zum CrossDataHub"

Überschrift der Dokumentation, die als

und im HTML-Title-Tag verwendet wird. Standardwert: "PowerShell Dokumentation zum CrossDataHub"

AUSGABEN

Es wird keine direkte Rückgabe erzeugt.

Die HTML-Datei wird unter dem angegebenen Pfad gespeichert.

BEISPIELE

# Konvertiert eine Markdown-Dokumentation in HTML mit Standardtitel.
Convert-MarkdownToHtml -InputPath '.\EulandaXTools.md' -OutputPath '.\EulandaXTools.html'
# Konvertiert eine Markdown-Datei mit individuellem Titel.
Convert-MarkdownToHtml -InputPath '.\docs\CrossDataHub.md' `
                            -OutputPath '.\docs\CrossDataHub.html' `
                            -Title 'CrossDataHub PowerShell Referenz'

VERWANDTE LINKS

https://doc.eulanda.eu/

HINWEISE