ConvertFrom-Markdown

  • Referenz
Modul:
Microsoft.PowerShell.Utility

Konvertieren Sie den Inhalt einer Zeichenfolge oder Datei in ein MarkdownInfo-Objekt .

Syntax

ConvertFrom-Markdown
                [-Path] <String[]>
                [-AsVT100EncodedString]
                [<CommonParameters>]
ConvertFrom-Markdown
                -LiteralPath <String[]>
                [-AsVT100EncodedString]
                [<CommonParameters>]
ConvertFrom-Markdown
                -InputObject <PSObject>
                [-AsVT100EncodedString]
                [<CommonParameters>]

Beschreibung

Mit diesem Cmdlet wird der angegebene Inhalt in ein MarkdownInfo konvertiert. Wenn für den Parameter "Path " ein Dateipfad angegeben wird, werden die Inhalte der Datei konvertiert. Das Ausgabeobjekt verfügt über drei Eigenschaften:

  • Die Token-Eigenschaft weist die abstrakte Syntaxstruktur (AST) des konvertierten Objekts auf.
  • Die HTML-Eigenschaft weist die HTML-Konvertierung der angegebenen Eingabe auf.
  • Die VT100EncodedString-Eigenschaft weist die konvertierte Zeichenfolge mit ANSI (VT100)-Escapesequenzen auf, wenn der AsVT100EncodedString-Parameter angegeben wurde.

Dieses Cmdlet wurde in PowerShell 6.1 eingeführt.

Beispiele

Beispiel 1: Konvertieren einer Datei mit Markdown-Inhalt in HTML

ConvertFrom-Markdown -Path .\README.md

Das MarkdownInfo-Objekt wird zurückgegeben. Die Token-Eigenschaft weist das AST des konvertierten Inhalts der README.md Datei auf. Die HTML-Eigenschaft verfügt über den HTML-konvertierten Inhalt der README.md Datei.

Beispiel 2: Konvertieren einer Datei mit Markdown-Inhalt in eine VT100-codierte Zeichenfolge

ConvertFrom-Markdown -Path .\README.md -AsVT100EncodedString

Das MarkdownInfo-Objekt wird zurückgegeben. Die Token-Eigenschaft weist das AST des konvertierten Inhalts der README.md Datei auf. Die VT100EncodedString-Eigenschaft weist die VT100-codierte Zeichenfolge auf, die den Inhalt der README.md Datei konvertiert hat.

Beispiel 3: Konvertieren eines Eingabeobjekts, das Markdown-Inhalt enthält, in eine VT100-codierte Zeichenfolge

Get-Item .\README.md | ConvertFrom-Markdown -AsVT100EncodedString

Das MarkdownInfo-Objekt wird zurückgegeben. Das FileInfo-Objekt Get-Item wird in eine VT100-codierte Zeichenfolge konvertiert. Die Token-Eigenschaft weist das AST des konvertierten Inhalts der README.md Datei auf. Die VT100EncodedString-Eigenschaft weist die VT100-codierte Zeichenfolge auf, die den Inhalt der README.md Datei konvertiert hat.

Beispiel 4: Konvertieren einer Zeichenfolge mit Markdown-Inhalt in eine VT100-codierte Zeichenfolge

"**Bold text**" | ConvertFrom-Markdown -AsVT100EncodedString

Das MarkdownInfo-Objekt wird zurückgegeben. Die angegebene Zeichenfolge **Bold text** wird in eine VT100-codierte Zeichenfolge konvertiert und in der VT100EncodedString-Eigenschaft verfügbar.

Parameter

-AsVT100EncodedString

Gibt an, ob die Ausgabe als Zeichenfolge mit VT100-Escapecodes codiert werden soll.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Gibt das zu konvertierende Objekt an. Wenn ein Objekt vom Typ "System.String " angegeben wird, wird die Zeichenfolge konvertiert. Wenn ein Objekt vom Typ System.IO.FileInfo angegeben wird, werden die Inhalte der durch das Objekt angegebenen Datei konvertiert. Objekte eines anderen Typs führen zu einem Fehler.

Type:PSObject
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-LiteralPath

Gibt einen Pfad zu der zu konvertierenden Datei an.

Type:String[]
Aliases:PSPath, LP
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Path

Gibt einen Pfad zu der zu konvertierenden Datei an.

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:True

Eingaben

PSObject

Ausgaben

Microsoft.PowerShell.MarkdownRender.MarkdownInfo