Show-Markdown

  • Referens
Modul:
Microsoft.PowerShell.Utility

Visar en Markdown-fil eller -sträng i konsolen på ett användarvänligt sätt med hjälp av VT100-escapesekvenser eller i en webbläsare med HTML.

Syntax

Show-Markdown
    [-Path] <String[]>
    [-UseBrowser]
    [<CommonParameters>]
Show-Markdown
    -InputObject <PSObject>
    [-UseBrowser]
    [<CommonParameters>]
Show-Markdown
    -LiteralPath <String[]>
    [-UseBrowser]
    [<CommonParameters>]

Description

Cmdleten Show-Markdown används för att återge Markdown i ett läsbart mänskligt format, antingen i en terminal eller i en webbläsare.

Show-Markdown kan returnera en sträng som innehåller de VT100-escape-sekvenser som terminalen renderar (om den stöder VT100-escape-sekvenser). Detta används främst för att visa Markdown-filer i en terminal. Du kan också hämta den här strängen ConvertFrom-Markdown via genom att ange parametern AsVT100EncodedString .

Show-Markdown har också möjlighet att öppna en webbläsare och visa en renderad version av Markdown. Den renderar Markdown genom att omvandla den till HTML och öppna HTML-filen i standardwebbläsaren.

Du kan ändra hur Show-Markdown Markdown återges i en terminal med hjälp Set-MarkdownOptionav .

Den här cmdleten introducerades i PowerShell 6.1.

Exempel

Exempel 1: Enkelt exempel som anger en sökväg

Show-Markdown -Path ./README.md

Exempel 2: Enkelt exempel som anger en sträng

@"
# Show-Markdown

## Markdown

You can now interact with Markdown via PowerShell!

*stars*
__underlines__
"@ | Show-Markdown

Exempel 2: Öppna Markdown i en webbläsare

Show-Markdown -Path ./README.md -UseBrowser

Parametrar

-InputObject

En Markdown-sträng som visas i terminalen. Om du inte skickar i ett format Show-Markdown som stöds genererar ett fel.

Typ:PSObject
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-LiteralPath

Anger sökvägen till en Markdown-fil. Till skillnad från parametern Path används värdet för LiteralPath precis som det skrivs. Inga tecken tolkas som jokertecken. Om sökvägen innehåller escape-tecken omger du den med enkla citattecken. Enkla citattecken gör att PowerShell inte tolkar några tecken som escape-sekvenser.

Typ:String[]
Alias:PSPath, LP
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Path

Anger sökvägen till en Markdown-fil som ska renderas.

Typ:String[]
Position:0
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:True

-UseBrowser

Kompilerar Markdown-indata som HTML och öppnar den i standardwebbläsaren.

Typ:SwitchParameter
Position:Named
Standardvärde:False
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

Indata

PSObject

String[]

Utdata

String