Show-Markdown
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
Path (Standard)
Show-Markdown
[-Path] <String[]>
[-UseBrowser]
[<CommonParameters>]
InputObject
Show-Markdown
-InputObject <PSObject>
[-UseBrowser]
[<CommonParameters>]
LiteralPath
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 via ConvertFrom-Markdown 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 renderar Markdown i en terminal med hjälp av Set-MarkdownOption.
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 som stöds genererar Show-Markdown ett fel.
Parameteregenskaper
| Typ: | PSObject |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
InputObject
| Position: | Named |
| Obligatorisk: | True |
| Värde från pipeline: | True |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | 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 wildcards. 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.
Parameteregenskaper
| Typ: | String[] |
| Standardvärde: | None |
| Stöder jokertecken: | False |
| DontShow: | False |
| Alias: | PSPath, SP |
Parameteruppsättningar
LiteralPath
| Position: | Named |
| Obligatorisk: | True |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | True |
| Värde från återstående argument: | False |
-Path
Anger sökvägen till en Markdown-fil som ska renderas.
Parameteregenskaper
| Typ: | String[] |
| Standardvärde: | None |
| Stöder jokertecken: | True |
| DontShow: | False |
Parameteruppsättningar
Path
| Position: | 0 |
| Obligatorisk: | True |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | True |
| Värde från återstående argument: | False |
-UseBrowser
Kompilerar Markdown-indata som HTML och öppnar den i standardwebbläsaren.
Parameteregenskaper
| Typ: | SwitchParameter |
| Standardvärde: | False |
| Stöder jokertecken: | False |
| DontShow: | False |
Parameteruppsättningar
(All)
| Position: | Named |
| Obligatorisk: | False |
| Värde från pipeline: | False |
| Värde från pipeline efter egenskapsnamn: | False |
| Värde från återstående argument: | False |
CommonParameters
Den här cmdleten stöder vanliga parametrar: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction och -WarningVariable. Mer information finns i about_CommonParameters.
