ConvertFrom-Markdown
Przekonwertuj zawartość ciągu lub pliku na obiekt MarkdownInfo.
Składnia
PathParamSet (Domyślna)
ConvertFrom-Markdown
[-Path] <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
LiteralParamSet
ConvertFrom-Markdown
-LiteralPath <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
InputObjParamSet
ConvertFrom-Markdown
-InputObject <PSObject>
[-AsVT100EncodedString]
[<CommonParameters>]
Opis
To polecenie cmdletu konwertuje określoną zawartość na MarkdownInfo. Po określeniu ścieżki pliku dla parametru Path zawartość pliku jest konwertowana. Obiekt wyjściowy ma trzy właściwości:
- Właściwość tokenu
ma drzewo składni abstrakcyjnej (AST) przekonwertowanego obiektu - Właściwość Html ma przekonwertowaną wersję HTML określonego wejścia.
- Właściwość VT100EncodedString zawiera przekonwertowany ciąg z sekwencjami ucieczki ANSI (VT100), jeśli określono parametr AsVT100EncodedString.
To polecenie cmdlet zostało wprowadzone w programie PowerShell 6.1.
Przykłady
Przykład 1. Konwertowanie pliku zawierającego zawartość języka Markdown na html
ConvertFrom-Markdown -Path .\README.md
Zwracany jest obiekt MarkdownInfo. Właściwość tokenów README.md.
Przykład 2. Konwertowanie pliku zawierającego zawartość języka Markdown na ciąg zakodowany w formacie VT100
ConvertFrom-Markdown -Path .\README.md -AsVT100EncodedString
Zwracany jest obiekt MarkdownInfo. Właściwość tokenów README.md przekonwertowaną z ciągu zakodowanego w formacie VT100.
Przykład 3. Konwertowanie obiektu wejściowego zawierającego zawartość markdown na ciąg zakodowany w formacie VT100
Get-Item .\README.md | ConvertFrom-Markdown -AsVT100EncodedString
Zwracany jest obiekt MarkdownInfo. Obiekt FileInfo z Get-Item jest konwertowany na ciąg znaków zakodowany w formacie VT100. Właściwość tokenów README.md przekonwertowaną z ciągu zakodowanego w formacie VT100.
Przykład 4. Konwertowanie ciągu zawierającego zawartość języka Markdown na ciąg zakodowany w formacie VT100
"**Bold text**" | ConvertFrom-Markdown -AsVT100EncodedString
Zwracany jest obiekt MarkdownInfo. Określony ciąg **Bold text** jest konwertowany na ciąg zakodowany w formacie VT100 i dostępny we właściwości VT100EncodedString.
Parametry
-AsVT100EncodedString
Określa, czy dane wyjściowe powinny być zakodowane jako ciąg z kodami ucieczki VT100.
Właściwości parametru
| Typ: | SwitchParameter |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
(All)
| Position: | Named |
| Obowiązkowy: | False |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-InputObject
Określa obiekt, który ma zostać przekonwertowany. Po określeniu obiektu typu System.String ciąg jest konwertowany. Po określeniu obiektu typu System.IO.FileInfo zawartość pliku określonego przez obiekt jest konwertowana. Obiekty dowolnego innego typu powodują błąd.
Właściwości parametru
| Typ: | PSObject |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
InputObjParamSet
| Position: | Named |
| Obowiązkowy: | True |
| Wartość z potoku: | True |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-LiteralPath
Określa ścieżkę do pliku, który ma zostać przekonwertowany.
Właściwości parametru
| Typ: | String[] |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
| Aliasy: | PSPath, LP |
Zestawy parametrów
LiteralParamSet
| Position: | Named |
| Obowiązkowy: | True |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
-Path
Określa ścieżkę do pliku, który ma zostać przekonwertowany.
Właściwości parametru
| Typ: | String[] |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | True |
| DontShow: | False |
Zestawy parametrów
PathParamSet
| Position: | 0 |
| Obowiązkowy: | True |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | False |
| Wartość z pozostałych argumentów: | False |
CommonParameters
To polecenie cmdlet obsługuje typowe parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction i -WarningVariable. Aby uzyskać więcej informacji, zobacz about_CommonParameters.
