Show-Markdown
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
Path (Domyślna)
Show-Markdown
[-Path] <String[]>
[-UseBrowser]
[<CommonParameters>]
InputObject
Show-Markdown
-InputObject <PSObject>
[-UseBrowser]
[<CommonParameters>]
LiteralPath
Show-Markdown
-LiteralPath <String[]>
[-UseBrowser]
[<CommonParameters>]
Opis
Polecenie cmdlet Show-Markdown 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 renderowane przez terminal (jeśli obsługuje sekwencje ucieczki VT100). Jest to używane głównie do wyświetlania plików Markdown w terminalu. Ten ciąg można również pobrać za pośrednictwem 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 renderowania języka Markdown Show-Markdown w terminalu przy użyciu 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.
Właściwości parametru
| Typ: | PSObject |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
Zestawy parametrów
InputObject
| 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 Markdown. W przeciwieństwie do parametru Path wartość LiterałuPath jest używana dokładnie tak, jak jest typowana. Żadne znaki nie są interpretowane jako symbole wieloznaczne. Jeśli ścieżka zawiera znaki ucieczki, należy ująć ją w pojedynczy cudzysłów. Pojedyncze cudzysłowy wskazują programowi PowerShell, aby nie interpretował żadnych znaków jako sekwencji ucieczki.
Właściwości parametru
| Typ: | String[] |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | False |
| DontShow: | False |
| Aliasy: | PSPath, LP |
Zestawy parametrów
LiteralPath
| Position: | Named |
| Obowiązkowy: | True |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | True |
| Wartość z pozostałych argumentów: | False |
-Path
Określa ścieżkę do pliku Markdown do renderowania.
Właściwości parametru
| Typ: | String[] |
| Domyślna wartość: | None |
| Obsługuje symbole wieloznaczne: | True |
| DontShow: | False |
Zestawy parametrów
Path
| Position: | 0 |
| Obowiązkowy: | True |
| Wartość z potoku: | False |
| Wartość z potoku według nazwy właściwości: | True |
| Wartość z pozostałych argumentów: | False |
-UseBrowser
Kompiluje dane wejściowe języka Markdown jako HTML i otwiera je w domyślnej przeglądarce.
Właściwości parametru
| Typ: | SwitchParameter |
| Domyślna wartość: | False |
| 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 |
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.
