当前位置:网站首页 > 更多 > 玩电脑 > 正文

[玩转系统] Show-Markdown (Microsoft.PowerShell.Utility)

作者:精品下载站 日期:2024-12-14 02:03:24 浏览:15 分类:玩电脑

Show-Markdown (Microsoft.PowerShell.Utility)


Show-Markdown

模块 :Microsoft.PowerShell.Utility

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

句法

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 将发出错误。

类型 :

PS对象

位置:

命名

默认值:

None

必需的:

True

接受管道输入:

True

接受通配符:

False

-LiteralPath

指定 Markdown 文件的路径。与 Path 参数不同,LiteralPath 的值完全按照键入的方式使用。没有字符被解释为通配符。如果路径包含转义字符,请将其用单引号引起来。单引号告诉 PowerShell 不要将任何字符解释为转义序列。

类型 :

String[]

别名:

PSPath, LP

位置:

命名

默认值:

None

必需的:

True

接受管道输入:

True

接受通配符:

False

-Path

指定要渲染的 Markdown 文件的路径。

类型 :

String[]

位置:

0

默认值:

None

必需的:

True

接受管道输入:

True

接受通配符:

True

-UseBrowser

将 Markdown 输入编译为 HTML 并在默认浏览器中打开它。

类型 :

SwitchParameter

位置:

命名

默认值:

False

必需的:

False

接受管道输入:

False

接受通配符:

False

输入

PSObject

字符串[]

输出

字符串

您需要 登录账户 后才能发表评论

取消回复欢迎 发表评论:

关灯