Delen via

Show-Markdown

  • Referentie
Module:
Microsoft.PowerShell.Utility

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

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 weer te geven in een door mensen leesbare indeling 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 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 wordt weergegeven 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, Show-Markdown wordt er een fout verzonden.

Type:PSObject
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren: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 escapetekens bevat, plaatst u het tussen enkele aanhalingstekens. Enkele aanhalingstekens geven PowerShell aan dat er geen tekens als escapereeksen moeten worden geïnterpreteerd.

Type:String[]
Aliassen:PSPath, LP
Position:Named
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:False

-Path

Hiermee geeft u het pad naar een Markdown-bestand dat moet worden weergegeven.

Type:String[]
Position:0
Default value:None
Vereist:True
Pijplijninvoer accepteren:True
Jokertekens accepteren:True

-UseBrowser

Compileert de Markdown-invoer als HTML en opent deze in uw standaardbrowser.

Type:SwitchParameter
Position:Named
Default value:False
Vereist:False
Pijplijninvoer accepteren:False
Jokertekens accepteren:False

Invoerwaarden

PSObject

String[]

Uitvoerwaarden

String