Show-Markdown
Toont een Markdown-bestand of -tekenreeks in de console op een beschrijvende manier met VT100-escapereeksen of in een browser met behulp van HTML.
Syntax
Show-Markdown
[-Path] <String[]>
[-UseBrowser]
[<CommonParameters>]
Show-Markdown
-InputObject <PSObject>
[-UseBrowser]
[<CommonParameters>]
Show-Markdown
-LiteralPath <String[]>
[-UseBrowser]
[<CommonParameters>]
Description
De Show-Markdown
cmdlet wordt gebruikt om Markdown in een door mensen leesbare indeling weer te geven in een terminal of in een browser.
Show-Markdown
kan een tekenreeks retourneren die de VT100-escapereeksen bevat die door de terminal worden weergegeven (als deze VT100-escapereeksen 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 te laten zien. 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 wordt weergegeven in een terminal 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 niet doorgeeft in een ondersteunde indeling, Show-Markdown
wordt er een fout gegenereerd.
Type: | PSObject |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-LiteralPath
Hiermee geeft u het pad naar een Markdown-bestand. In tegenstelling tot de path-parameter wordt de waarde van LiteralPath precies gebruikt zoals deze is getypt. Geen tekens worden geïnterpreteerd als jokertekens. Als het pad escape-tekens bevat, plaatst u het tussen enkele aanhalingstekens. Enkele aanhalingstekens geven PowerShell aan dat geen tekens als escape-reeksen worden geïnterpreteerd.
Type: | String[] |
Aliases: | PSPath, LP |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Path
Hiermee geeft u het pad naar een Markdown-bestand dat moet worden weergegeven.
Type: | String[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | True |
-UseBrowser
Hiermee compileert u de Markdown-invoer als HTML en opent u deze in uw standaardbrowser.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Invoerwaarden
String[]