Freigeben über

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 Path Parameter 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 parameter AsVT100EncodedString 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--Objekts wird zurückgegeben. Die Token--Eigenschaft weist den AST des konvertierten Inhalts der README.md Datei auf. Die Html--Eigenschaft weist den HTML-konvertierten Inhalt der README.md Datei auf.

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

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

Das MarkdownInfo--Objekts wird zurückgegeben. Die Token--Eigenschaft weist den AST des konvertierten Inhalts der README.md Datei auf. Die VT100EncodedString--Eigenschaft verfügt über die VT100-codierte Zeichenfolge, 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--Objekts wird zurückgegeben. Das FileInfo- objekt aus Get-Item wird in eine VT100-codierte Zeichenfolge konvertiert. Die Token--Eigenschaft weist den AST des konvertierten Inhalts der README.md Datei auf. Die VT100EncodedString--Eigenschaft verfügt über die VT100-codierte Zeichenfolge, 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--Objekts wird zurückgegeben. Die angegebene Zeichenfolge **Bold text** wird in eine VT100-codierte Zeichenfolge konvertiert und in VT100EncodedString-Eigenschaft verfügbar.

Parameter

-AsVT100EncodedString

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

Typ:SwitchParameter
Position:Named
Standardwert:None
Erforderlich:False
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren: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.

Typ:PSObject
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:True
Platzhalterzeichen akzeptieren:False

-LiteralPath

Gibt einen Pfad zu der zu konvertierenden Datei an.

Typ:String[]
Aliase:PSPath, LP
Position:Named
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:False

-Path

Gibt einen Pfad zu der zu konvertierenden Datei an.

Typ:String[]
Position:0
Standardwert:None
Erforderlich:True
Pipelineeingabe akzeptieren:False
Platzhalterzeichen akzeptieren:True

Eingaben

PSObject

Ausgaben

Microsoft.PowerShell.MarkdownRender.MarkdownInfo