ConvertFrom-Markdown
Převeďte obsah řetězce nebo souboru na objekt MarkdownInfo .
Syntaxe
ConvertFrom-Markdown
[-Path] <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
ConvertFrom-Markdown
-LiteralPath <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
ConvertFrom-Markdown
-InputObject <PSObject>
[-AsVT100EncodedString]
[<CommonParameters>]
Description
Tato rutina převede zadaný obsah na MarkdownInfo. Pokud je pro parametr Cesta zadána cesta k souboru, obsah souboru se převede. Výstupní objekt má tři vlastnosti:
- Vlastnost Token má abstraktní strom syntaxe (AST) převedeného objektu.
- Vlastnost Html má převod HTML zadaného vstupu.
- Vlastnost VT100EncodedString má převedený řetězec s řídicími sekvencemi ANSI (VT100), pokud byl zadán parametr AsVT100EncodedString .
Tato rutina byla zavedena v PowerShellu 6.1.
Příklady
Příklad 1: Převedení souboru obsahujícího obsah Markdownu na HTML
ConvertFrom-Markdown -Path .\README.md
Vrátí se objekt MarkdownInfo . Vlastnost Tokens má AST převedeného obsahu README.md
souboru. Html vlastnost má HTML převedený obsah README.md
souboru.
Příklad 2: Převedení souboru obsahujícího obsah Markdownu na řetězec s kódováním VT100
ConvertFrom-Markdown -Path .\README.md -AsVT100EncodedString
Vrátí se objekt MarkdownInfo . Vlastnost Tokens má AST převedeného obsahu README.md
souboru. Vlastnost VT100EncodedString má řetězec kódovaný VT100 převedený obsah README.md
souboru.
Příklad 3: Převedení vstupního objektu obsahujícího obsah Markdownu na řetězec kódovaný VT100
Get-Item .\README.md | ConvertFrom-Markdown -AsVT100EncodedString
Vrátí se objekt MarkdownInfo . FileInfo objekt z Get-Item
je převeden na VT100 kódovaný řetězec. Vlastnost Tokens má AST převedeného obsahu README.md
souboru. Vlastnost VT100EncodedString má řetězec kódovaný VT100 převedený obsah README.md
souboru.
Příklad 4: Převedení řetězce obsahujícího obsah Markdownu na řetězec kódovaný VT100
"**Bold text**" | ConvertFrom-Markdown -AsVT100EncodedString
Vrátí se objekt MarkdownInfo . Zadaný řetězec **Bold text**
je převeden na řetězec kódovaný VT100 a je k dispozici ve vlastnosti VT100EncodedString .
Parametry
-AsVT100EncodedString
Určuje, jestli má být výstup kódován jako řetězec s řídicími kódy VT100.
Typ: | SwitchParameter |
Position: | Named |
Default value: | None |
Vyžadováno: | False |
Přijmout vstup kanálu: | False |
Přijmout zástupné znaky: | False |
-InputObject
Určuje objekt, který se má převést. Pokud je zadán objekt typu System.String , řetězec je převeden. Pokud je zadán objekt typu System.IO.FileInfo , obsah souboru určeného objektem jsou převedeny. Objekty jakéhokoli jiného typu způsobí chybu.
Typ: | PSObject |
Position: | Named |
Default value: | None |
Vyžadováno: | True |
Přijmout vstup kanálu: | True |
Přijmout zástupné znaky: | False |
-LiteralPath
Určuje cestu k souboru, který se má převést.
Typ: | String[] |
Aliasy: | PSPath, LP |
Position: | Named |
Default value: | None |
Vyžadováno: | True |
Přijmout vstup kanálu: | False |
Přijmout zástupné znaky: | False |
-Path
Určuje cestu k souboru, který se má převést.
Typ: | String[] |
Position: | 0 |
Default value: | None |
Vyžadováno: | True |
Přijmout vstup kanálu: | False |
Přijmout zástupné znaky: | True |
Vstupy
Výstupy
Microsoft.PowerShell.MarkdownRender.MarkdownInfo