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>]
说明
Show-Markdown cmdlet 用于在终端或浏览器中以人工可读格式呈现 Markdown。
Show-Markdown 可以返回一个字符串，其中包含终端呈现的 VT100 转义序列（如果它支持 VT100 转义序列）。 这主要用于在终端中查看 Markdown 文件。 你还可以通过指定 ConvertFrom-Markdown 参数通过 来获取此字符串。
Show-Markdown 还可以打开浏览器并显示 Markdown 的呈现版本。 它通过将 Markdown 转换为 HTML 并在默认浏览器中打开 HTML 文件来呈现 Markdown。
可以使用 Show-Markdown更改 Set-MarkdownOption 在终端中呈现 Markdown 的方式。
PowerShell 6.1 中引入了此 cmdlet。
示例
示例 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。
