Show-Markdown

  • 參考
模組:
Microsoft.PowerShell.Utility

使用 VT100 逸出序列或在瀏覽器中使用 HTML，以易記的方式在控制台中顯示 Markdown 檔案或字串。

Syntax

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

Description

Cmdlet Show-Markdown 用來在終端機或瀏覽器中以人類可讀取格式轉譯 Markdown。

Show-Markdown 可以傳回字串，其中包含終端所轉譯的 VT100 逸出序列（如果支援 VT100 逸出序列）。 這主要用於在終端機中檢視 Markdown 檔案。 您也可以透過 指定 AsVT100EncodedString 參數來取得此字串ConvertFrom-Markdown。

Show-Markdown 也能夠開啟瀏覽器，並顯示轉譯版本的 Markdown。 它會將 Markdown 轉換成 HTML，並在預設瀏覽器中開啟 HTML 檔案來轉譯 Markdown。

您可以使用 來變更在終端Set-MarkdownOption機中轉譯 Markdown 的方式Show-Markdown。

此 Cmdlet 已在 PowerShell 6.1 中引進。

範例

範例 1：指定路徑的簡單範例

Show-Markdown -Path ./README.md

範例 2：指定字串的簡單範例

@"
# Show-Markdown

## Markdown

You can now interact with Markdown via PowerShell!

*stars*
__underlines__
"@ | Show-Markdown

範例 2：在瀏覽器中開啟 Markdown

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

參數

-InputObject

將在終端機中顯示的 Markdown 字串。 如果您未以支援的格式傳遞， Show-Markdown 將會發出錯誤。

Type:PSObject
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-LiteralPath

指定 Markdown 檔案的路徑。 不同於Path參數，LiteralPath的值會與輸入時完全相同。 不會將任何字元解譯為通配符。 如果路徑包含逸出字元，請以單引弧括住它。 單引號會告知PowerShell不要將任何字元解譯為逸出序列。

Type:String[]
Aliases:PSPath, LP
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Path

指定要轉譯之 Markdown 檔案的路徑。

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:True

-UseBrowser

將 Markdown 輸入編譯為 HTML，並在預設瀏覽器中開啟它。

Type:SwitchParameter
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

輸入

PSObject

String[]

輸出

String