ConvertTo-MarkdownBlock #

ÜBERSICHT #

Bereitet einen Textblock aus PowerShell-Kommentarabschnitten für Markdown auf, indem Einrückungen normalisiert und Absätze automatisch erkannt und getrennt werden.

SYNTAX #

ConvertTo-MarkdownBlock [[-Lines] <string[]>] [<CommonParameters>]

BESCHREIBUNG #

Diese Funktion entfernt automatisch die gemeinsame Basis-Einrückung aller Zeilen eines Textblocks, welcher typischerweise aus Kommentarabschnitten wie .DESCRIPTION, .NOTES oder ähnlichen Abschnitten eines PowerShell-Skriptkommentars stammt. Folgende Regeln werden dabei angewendet:

• Die Basis-Einrückung wird anhand der ersten nicht-leeren Zeile ermittelt und bei allen Zeilen entfernt.
• Absätze werden durch Leerzeilen, Überschriften (#) oder Listenpunkte (-, *, 1. usw.) erkannt.
• Einrückungen, die stilistisch tiefer als die Basis-Einrückung sind, werden als Tabulatoren übernommen.
• Inline-Markdown-Formatierungen wie Backticks (```), Kursiv (*), Fett (**) bleiben erhalten.

PARAMETER #

-Lines #

Type: string[]

Ein Array von Zeichenketten, das einen Textblock repräsentiert, typischerweise aus Kommentarabschnitten eines PowerShell-Skriptkommentars (z. B. .DESCRIPTION, .NOTES).

Die einzelnen Zeilen können eingerückt sein. Die Funktion ermittelt automatisch die gemeinsame Basis-Einrückung und entfernt diese. Leerzeilen, Überschriften und Listenpunkte werden erkannt und entsprechend als Markdown-Absätze, Überschriften oder Listen formatiert.

BEISPIELE #

$textBlock = @(
  "    Dies ist eine Beschreibung mit Basis-Einrückung.",
  "    Sie enthält mehrere Zeilen, die zu einem Absatz zusammengefasst werden.",
  "",
  "    - Listenpunkt eins,",
  "      mit Folgezeile.",
  "    - Zweiter Listenpunkt.",
  "",
  "    ### Unterüberschrift",
  "",
  "    Weiterer Text nach einer Leerzeile.",
  "",
  "      Zusätzliche stilistische Einrückung."
)

ConvertTo-MarkdownBlock -Lines $textBlock

# Ergebnis:
#
# Dies ist eine Beschreibung mit Basis-Einrückung. Sie enthält mehrere Zeilen, die zu einem Absatz zusammengefasst werden.
#
# - Listenpunkt eins, mit Folgezeile.
# - Zweiter Listenpunkt.
#
# ### Unterüberschrift
#
# Weiterer Text nach einer Leerzeile.
#
#     Zusätzliche stilistische Einrückung.

$textBlock = @(
  "  Diese Funktion gibt `TRUE` zurück, wenn erfolgreich, oder `FALSE` bei Problemen.",
  "",
  "  Hinweise:",
  "  - Verwendung von `-Force` überschreibt bestehende Installationen."
)

ConvertTo-MarkdownBlock -Lines $textBlock

# Ergebnis:
#
# Diese Funktion gibt `TRUE` zurück, wenn erfolgreich, oder `FALSE` bei Problemen.
#
# Hinweise:
# - Verwendung von `-Force` überschreibt bestehende Installationen.