Show-Markdown
Zobrazuje soubor nebo řetězec Markdownu v konzole srozumitelným způsobem pomocí řídicích sekvencí VT100 nebo v prohlížeči pomocí HTML.
Syntax
Show-Markdown
[-Path] <String[]>
[-UseBrowser]
[<CommonParameters>]
Show-Markdown
-InputObject <PSObject>
[-UseBrowser]
[<CommonParameters>]
Show-Markdown
-LiteralPath <String[]>
[-UseBrowser]
[<CommonParameters>]
Description
Rutina Show-Markdown
se používá k vykreslení Markdownu v čitelném formátu člověka v terminálu nebo v prohlížeči.
Show-Markdown
může vrátit řetězec, který obsahuje řídicí sekvence VT100, které terminál vykresluje (pokud podporuje řídicí sekvence VT100). Používá se primárně k prohlížení souborů Markdownu v terminálu. Tento řetězec můžete získat také zadáním ConvertFrom-Markdown
parametru AsVT100EncodedString .
Show-Markdown
má také možnost otevřít prohlížeč a zobrazit vykreslenou verzi Markdownu. Markdown vykreslí tak, že ho převede na HTML a otevře soubor HTML ve výchozím prohlížeči.
Způsob vykreslení Markdownu v terminálu můžete změnit Show-Markdown
pomocí funkce Set-MarkdownOption
.
Tato rutina byla zavedena v PowerShellu 6.1.
Příklady
Příklad 1: Jednoduchý příklad určující cestu
Show-Markdown -Path ./README.md
Příklad 2: Jednoduchý příklad zadání řetězce
@"
# Show-Markdown
## Markdown
You can now interact with Markdown via PowerShell!
*stars*
__underlines__
"@ | Show-Markdown
Příklad 2: Otevření Markdownu v prohlížeči
Show-Markdown -Path ./README.md -UseBrowser
Parametry
-InputObject
Řetězec Markdownu, který se zobrazí v terminálu. Pokud nepředáte podporovaný formát, Show-Markdown
vygeneruje se chyba.
Type: | PSObject |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-LiteralPath
Určuje cestu k souboru Markdownu. Na rozdíl od parametru Path se hodnota LiteralPath používá přesně tak, jak je zadána. Žádné znaky nejsou interpretovány jako zástupné znaky. Pokud cesta obsahuje řídicí znaky, uzavřete ji do jednoduchých uvozovek. Jednoduché uvozovky říkají PowerShellu, aby nepřekládaly žádné znaky jako řídicí sekvence.
Type: | String[] |
Aliases: | PSPath, LP |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Path
Určuje cestu k souboru Markdownu, který se má vykreslit.
Type: | String[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | True |
-UseBrowser
Zkompiluje vstup Markdownu jako HTML a otevře ho ve výchozím prohlížeči.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Vstupy
String[]
Výstupy
Související odkazy
Váš názor
https://aka.ms/ContentUserFeedback.
Připravujeme: V průběhu roku 2024 budeme postupně vyřazovat problémy z GitHub coby mechanismus zpětné vazby pro obsah a nahrazovat ho novým systémem zpětné vazby. Další informace naleznete v tématu:Odeslat a zobrazit názory pro