Show-Markdown

  • 参考
模块:
Microsoft.PowerShell.Utility

使用 VT100 转义序列以友好方式在控制台中显示 Markdown 文件或字符串，或者使用 HTML 在浏览器中显示。

语法

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

说明

Show-Markdown cmdlet 用于在终端或浏览器中以人工可读格式呈现 Markdown。

Show-Markdown 可以返回一个字符串，其中包含终端呈现的 VT100 转义序列（如果支持 VT100 转义序列）。 这主要用于在终端中查看 Markdown 文件。 你还可以通过指定 AsVT100EncodedString 参数通过 ConvertFrom-Markdown 来获取此字符串。

Show-Markdown 还可以打开浏览器并显示 Markdown 的呈现版本。 它通过将 Markdown 转换为 HTML 并在默认浏览器中打开 HTML 文件来呈现 Markdown。

你可以使用 Set-MarkdownOption 更改 Show-Markdown 在终端中呈现 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