ConvertFrom-Markdown
Konvertieren Sie den Inhalt einer Zeichenfolge oder datei in ein MarkdownInfo--Objekt.
Syntax
PathParamSet (Standardwert)
ConvertFrom-Markdown
[-Path] <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
LiteralParamSet
ConvertFrom-Markdown
-LiteralPath <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
InputObjParamSet
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.
Parametereigenschaften
| Typ: | SwitchParameter |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
(All)
| Position: | Named |
| Obligatorisch.: | False |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | 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.
Parametereigenschaften
| Typ: | PSObject |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
Parametersätze
InputObjParamSet
| Position: | Named |
| Obligatorisch.: | True |
| Wert aus Pipeline: | True |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-LiteralPath
Gibt einen Pfad zu der zu konvertierenden Datei an.
Parametereigenschaften
| Typ: | String[] |
| Standardwert: | None |
| Unterstützt Platzhalter: | False |
| Nicht anzeigen: | False |
| Aliase: | PSPath, EP |
Parametersätze
LiteralParamSet
| Position: | Named |
| Obligatorisch.: | True |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
-Path
Gibt einen Pfad zu der zu konvertierenden Datei an.
Parametereigenschaften
| Typ: | String[] |
| Standardwert: | None |
| Unterstützt Platzhalter: | True |
| Nicht anzeigen: | False |
Parametersätze
PathParamSet
| Position: | 0 |
| Obligatorisch.: | True |
| Wert aus Pipeline: | False |
| Wert aus Pipeline nach dem Eigenschaftsnamen: | False |
| Wert aus verbleibenden Argumenten: | False |
CommonParameters
Dieses Cmdlet unterstützt die allgemeinen Parameter -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction und -WarningVariable. Weitere Informationen findest du unter about_CommonParameters.
