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.
Syntaxe
Path (Výchozí)
Show-Markdown
[-Path] <String[]>
[-UseBrowser]
[<CommonParameters>]
InputObject
Show-Markdown
-InputObject <PSObject>
[-UseBrowser]
[<CommonParameters>]
LiteralPath
Show-Markdown
-LiteralPath <String[]>
[-UseBrowser]
[<CommonParameters>]
Description
Cmdlet Show-Markdown slouží k vykreslení Markdownu v čitelném formátu pro lidi v terminálu nebo v prohlížeči.
Show-Markdown může vrátit řetězec, který obsahuje únikové sekvence VT100, které terminál vykresluje (pokud podporuje únikové sekvence VT100). Používá se primárně k prohlížení souborů Markdownu v terminálu. Tento řetězec můžete získat také prostřednictvím ConvertFrom-Markdown zadáním 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, jakým Show-Markdown vykresluje Markdown v terminálu, můžete změnit pomocí 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 specifikace ř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 chybu.
Vlastnosti parametru
| Typ: | PSObject |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
InputObject
| Position: | Named |
| Povinné: | True |
| Hodnota z kanálu: | True |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | 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ý znak není interpretován jako zástupný znak. Pokud cesta obsahuje únikové znaky, uzavřete ji do jednoduchých uvozovek. Jednoduché uvozovky říkají PowerShellu, aby žádné znaky neinterpretoval jako únikové sekvence.
Vlastnosti parametru
| Typ: | String[] |
| Default value: | None |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
| Aliasy: | PSPath, PO |
Sady parametrů
LiteralPath
| Position: | Named |
| Povinné: | True |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | True |
| Hodnota ze zbývajících argumentů: | False |
-Path
Určuje cestu k souboru Markdownu, který se má vykreslit.
Vlastnosti parametru
| Typ: | String[] |
| Default value: | None |
| Podporuje zástupné znaky: | True |
| DontShow: | False |
Sady parametrů
Path
| Position: | 0 |
| Povinné: | True |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | True |
| Hodnota ze zbývajících argumentů: | False |
-UseBrowser
Zkompiluje vstup Markdownu jako HTML a otevře ho ve výchozím prohlížeči.
Vlastnosti parametru
| Typ: | SwitchParameter |
| Default value: | False |
| Podporuje zástupné znaky: | False |
| DontShow: | False |
Sady parametrů
(All)
| Position: | Named |
| Povinné: | False |
| Hodnota z kanálu: | False |
| Hodnota z kanálu podle názvu vlastnosti: | False |
| Hodnota ze zbývajících argumentů: | False |
CommonParameters
Tato rutina podporuje běžné parametry: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction a -WarningVariable. Další informace najdete v about_CommonParameters.
