Udostępnij za pośrednictwem

Show-Markdown

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

Pokazuje plik markdown lub ciąg w konsoli w przyjazny sposób przy użyciu sekwencji ucieczki VT100 lub w przeglądarce przy użyciu kodu HTML.

Składnia

Show-Markdown
    [-Path] <String[]>
    [-UseBrowser]
    [<CommonParameters>]
Show-Markdown
    -InputObject <PSObject>
    [-UseBrowser]
    [<CommonParameters>]
Show-Markdown
    -LiteralPath <String[]>
    [-UseBrowser]
    [<CommonParameters>]

Opis

Polecenie Show-Markdown cmdlet służy do renderowania języka Markdown w formacie czytelnym dla człowieka w terminalu lub w przeglądarce.

Show-Markdown może zwrócić ciąg zawierający sekwencje ucieczki VT100, które renderuje terminal (jeśli obsługuje sekwencje ucieczki VT100). Jest to używane głównie do wyświetlania plików Markdown w terminalu. Możesz również pobrać ten ciąg za pomocą parametru ConvertFrom-Markdown , określając parametr AsVT100EncodedString .

Show-Markdown Ma również możliwość otwierania przeglądarki i wyświetlania renderowanej wersji języka Markdown. Renderuje on język Markdown, przekształcając go w kod HTML i otwierając plik HTML w domyślnej przeglądarce.

Możesz zmienić sposób Show-Markdown renderowania języka Markdown w terminalu przy użyciu polecenia Set-MarkdownOption.

To polecenie cmdlet zostało wprowadzone w programie PowerShell 6.1.

Przykłady

Przykład 1. Prosty przykład określający ścieżkę

Show-Markdown -Path ./README.md

Przykład 2. Prosty przykład określający ciąg

@"
# Show-Markdown

## Markdown

You can now interact with Markdown via PowerShell!

*stars*
__underlines__
"@ | Show-Markdown

Przykład 2: otwieranie języka Markdown w przeglądarce

Show-Markdown -Path ./README.md -UseBrowser

Parametry

-InputObject

Ciąg języka Markdown, który zostanie wyświetlony w terminalu. Jeśli nie przekażesz obsługiwanego formatu, Show-Markdown wyemituje 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 Markdown. W przeciwieństwie do parametru Path wartość LiterałuPath jest używana dokładnie tak, jak jest typowana. Znaki nie są interpretowane jako symbole wieloznaczne. Jeśli ścieżka zawiera znaki ucieczki, należy ująć ją w pojedynczy cudzysłów. Pojedyncze znaki cudzysłowu informują program PowerShell, aby nie interpretował żadnych znaków jako sekwencji ucieczki.

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

-Path

Określa ścieżkę do pliku Markdown do renderowania.

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

-UseBrowser

Kompiluje dane wejściowe języka Markdown jako HTML i otwiera je w domyślnej przeglądarce.

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

Dane wejściowe

PSObject

String[]

Dane wyjściowe

String