Show-Markdown
Wyświetla plik markdown lub ciąg w konsoli w przyjazny sposób przy użyciu sekwencji ucieczki VT100 lub w przeglądarce przy użyciu języka 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
program może zwrócić ciąg zawierający sekwencje ucieczki VT100 renderowane przez 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ść otwarcia przeglądarki i wyświetlenia renderowanej wersji języka Markdown. Renderuje kod Markdown, przekształcając go w kod HTML i otwierając plik HTML w domyślnej przeglądarce.
Sposób renderowania języka Markdown w terminalu można zmienić Show-Markdown
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 kodu Markdown w przeglądarce
Show-Markdown -Path ./README.md -UseBrowser
Parametry
-InputObject
Ciąg języka Markdown, który będzie wyświetlany w terminalu. Jeśli nie przekażesz obsługiwanego formatu, Show-Markdown
wyemituje błąd.
Type: | PSObject |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | 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 znaki pojedynczego cudzysłowu. Znaki pojedynczego cudzysłowu informują program PowerShell, aby nie interpretował żadnych znaków jako sekwencji ucieczki.
Type: | String[] |
Aliases: | PSPath, LP |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Path
Określa ścieżkę do pliku Markdown do renderowania.
Type: | String[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | True |
-UseBrowser
Kompiluje dane wejściowe języka Markdown jako HTML i otwiera je w domyślnej przeglądarce.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Dane wejściowe
String[]