Show-Markdown
Toont een Markdown-bestand of -tekenreeks in de console op een beschrijvende manier met behulp van VT100 escape-reeksen of in een browser met HTML.
Syntaxis
Path (Standaard)
Show-Markdown
[-Path] <String[]>
[-UseBrowser]
[<CommonParameters>]
InputObject
Show-Markdown
-InputObject <PSObject>
[-UseBrowser]
[<CommonParameters>]
LiteralPath
Show-Markdown
-LiteralPath <String[]>
[-UseBrowser]
[<CommonParameters>]
Description
De cmdlet Show-Markdown wordt gebruikt om Markdown weer te geven in een door mensen leesbare indeling in een terminal of in een browser.
Show-Markdown kan een tekenreeks retourneren die de escapereeksen VT100 bevat die door de terminal worden weergegeven (als deze VT100 escape-reeksen ondersteunt). Dit wordt voornamelijk gebruikt voor het weergeven van Markdown-bestanden in een terminal. U kunt deze tekenreeks ook ophalen via de ConvertFrom-Markdown door de parameter AsVT100EncodedString op te geven.
Show-Markdown heeft ook de mogelijkheid om een browser te openen en u een gerenderde versie van de Markdown weer te geven. De Markdown wordt weergegeven door deze om te zetten in HTML en het HTML-bestand te openen in uw standaardbrowser.
U kunt wijzigen hoe Show-Markdown Markdown in een terminal weergeeft met behulp van Set-MarkdownOption.
Deze cmdlet is geïntroduceerd in PowerShell 6.1.
Voorbeelden
Voorbeeld 1: Eenvoudig voorbeeld waarin een pad wordt opgegeven
Show-Markdown -Path ./README.md
Voorbeeld 2: Eenvoudig voorbeeld waarin een tekenreeks wordt opgegeven
@"
# Show-Markdown
## Markdown
You can now interact with Markdown via PowerShell!
*stars*
__underlines__
"@ | Show-Markdown
Voorbeeld 2: Markdown openen in een browser
Show-Markdown -Path ./README.md -UseBrowser
Parameters
-InputObject
Een Markdown-tekenreeks die wordt weergegeven in de terminal. Als u geen ondersteunde indeling doorgeeft, zal Show-Markdown een fout veroorzaken.
Parametereigenschappen
| Type: | PSObject |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
InputObject
| Position: | Named |
| Verplicht: | True |
| Waarde uit pijplijn: | True |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
-LiteralPath
Hiermee geeft u het pad naar een Markdown-bestand. In tegenstelling tot de parameter Path wordt de waarde van LiteralPath exact gebruikt zoals deze is getypt. Er worden geen tekens geïnterpreteerd als jokertekens. Als het pad escape-tekens bevat, zet het dan tussen enkele aanhalingstekens. Enkele aanhalingstekens zorgen ervoor dat PowerShell geen tekens als escapesequenties interpreteert.
Parametereigenschappen
| Type: | String[] |
| Default value: | None |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
| Aliassen: | PSPath, LP |
Parametersets
LiteralPath
| Position: | Named |
| Verplicht: | True |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | True |
| Waarde van resterende argumenten: | False |
-Path
Hiermee geeft u het pad naar een Markdown-bestand dat moet worden weergegeven.
Parametereigenschappen
| Type: | String[] |
| Default value: | None |
| Ondersteunt jokertekens: | True |
| DontShow: | False |
Parametersets
Path
| Position: | 0 |
| Verplicht: | True |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | True |
| Waarde van resterende argumenten: | False |
-UseBrowser
Compileert de Markdown-invoer als HTML en opent deze in uw standaardbrowser.
Parametereigenschappen
| Type: | SwitchParameter |
| Default value: | False |
| Ondersteunt jokertekens: | False |
| DontShow: | False |
Parametersets
(All)
| Position: | Named |
| Verplicht: | False |
| Waarde uit pijplijn: | False |
| Waarde uit pijplijn op eigenschapsnaam: | False |
| Waarde van resterende argumenten: | False |
CommonParameters
Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.
