共用方式為


Show-Markdown

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

語法

Path (預設值)

Show-Markdown
    [-Path] <String[]>
    [-UseBrowser]
    [<CommonParameters>]

InputObject

Show-Markdown
    -InputObject <PSObject>
    [-UseBrowser]
    [<CommonParameters>]

LiteralPath

Show-Markdown
    -LiteralPath <String[]>
    [-UseBrowser]
    [<CommonParameters>]

Description

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

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

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

您可以使用 Show-Markdown來變更 Set-MarkdownOption 在終端機中轉譯 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 會發出錯誤。

參數屬性

類型:PSObject
預設值:None
支援萬用字元:False
不要顯示:False

參數集

InputObject
Position:Named
必要:True
來自管線的值:True
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-LiteralPath

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

參數屬性

類型:

String[]

預設值:None
支援萬用字元:False
不要顯示:False
別名:PSPath, LP

參數集

LiteralPath
Position:Named
必要:True
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-Path

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

參數屬性

類型:

String[]

預設值:None
支援萬用字元:True
不要顯示:False

參數集

Path
Position:0
必要:True
來自管線的值:False
來自管線按屬性名稱的值:True
來自剩餘引數的值:False

-UseBrowser

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

參數屬性

類型:SwitchParameter
預設值:False
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

CommonParameters

此 Cmdlet 支援一般參數:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters

輸入

PSObject

String

輸出

String