Udostępnij za pośrednictwem

ConvertFrom-Markdown

  • Odwołanie
Moduł:
Microsoft.PowerShell.Utility

Przekonwertuj zawartość ciągu lub pliku na obiekt MarkdownInfo .

Składnia

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

Opis

To polecenie cmdlet konwertuje określoną zawartość na znaczników 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ść Token ma drzewo składni abstrakcyjnej (AST) przekonwertowanego obiektu
  • Właściwość Html ma konwersję HTML określonego danych wejściowych
  • Właściwość VT100EncodedString ma 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ść Tokens ma AST przekonwertowanej zawartości README.md pliku. Właściwość Html ma przekonwertowaną zawartość README.md w formacie HTML pliku.

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ść Tokens ma AST przekonwertowanej zawartości README.md pliku. Właściwość VT100EncodedString ma ciąg zakodowany w formacie VT100 przekonwertowany na README.md zawartość pliku.

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 zakodowany w formacie VT100. Właściwość Tokens ma AST przekonwertowanej zawartości README.md pliku. Właściwość VT100EncodedString ma ciąg zakodowany w formacie VT100 przekonwertowany na README.md zawartość pliku.

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.

Typ:SwitchParameter
Position:Named
Domyślna wartość:None
Wymagane:False
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych: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.

Typ:PSObject
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:True
Akceptowanie symboli wieloznacznych:False

-LiteralPath

Określa ścieżkę do pliku, który ma zostać przekonwertowany.

Typ:String[]
Aliasy:PSPath, LP
Position:Named
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:False

-Path

Określa ścieżkę do pliku, który ma zostać przekonwertowany.

Typ:String[]
Position:0
Domyślna wartość:None
Wymagane:True
Akceptowanie danych wejściowych potoku:False
Akceptowanie symboli wieloznacznych:True

Dane wejściowe

PSObject

Dane wyjściowe

Microsoft.PowerShell.MarkdownRender.MarkdownInfo