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 檔案來渲染。

你可以用 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 將會發出錯誤。

參數屬性

類型: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