ConvertFrom-Markdown

  • 参考
模块:
Microsoft.PowerShell.Utility

将字符串或文件的内容转换为 MarkdownInfo 对象。

语法

ConvertFrom-Markdown
                [-Path] <String[]>
                [-AsVT100EncodedString]
                [<CommonParameters>]
ConvertFrom-Markdown
                -LiteralPath <String[]>
                [-AsVT100EncodedString]
                [<CommonParameters>]
ConvertFrom-Markdown
                -InputObject <PSObject>
                [-AsVT100EncodedString]
                [<CommonParameters>]

说明

此 cmdlet 将指定的内容转换为 MarkdownInfo。 为 Path 参数指定文件路径时，会转换文件上的内容。 输出对象具有三个属性：

  • Token 属性具有已转换对象的抽象语法树 （AST）
  • Html 属性具有指定输入的 HTML 转换
  • 如果指定了 AsVT100EncodedString 参数，则 VT100EncodedString 属性具有带 ANSI (VT100) 转义序列的转换字符串

此 cmdlet 在 PowerShell 6.1 中引入。

示例

示例 1：将包含 Markdown 内容的文件转换为 HTML

ConvertFrom-Markdown -Path .\README.md

返回 MarkdownInfo 对象。 Tokens 属性具有 README.md 文件转换后内容的 AST。 Html 属性具有 README.md 文件转换后内容的 HTML。

示例 2：将包含 Markdown 内容的文件转换为 VT100 编码字符串

ConvertFrom-Markdown -Path .\README.md -AsVT100EncodedString

返回 MarkdownInfo 对象。 Tokens 属性具有 README.md 文件转换后内容的 AST。 VT100EncodedString 属性具有 README.md 文件的 VT100 编码字符串转换后内容。

示例 3：将包含 Markdown 内容的文件转换为 VT100 编码字符串

Get-Item .\README.md | ConvertFrom-Markdown -AsVT100EncodedString

返回 MarkdownInfo 对象。 Get-Item 中的 FileInfo 对象转换为 VT100 编码字符串。 Tokens 属性具有 README.md 文件转换后内容的 AST。 VT100EncodedString 属性具有 README.md 文件的 VT100 编码字符串转换后内容。

示例 4：将包含 Markdown 内容的字符串转换为 VT100 编码字符串

"**Bold text**" | ConvertFrom-Markdown -AsVT100EncodedString

返回 MarkdownInfo 对象。 指定的字符串 **Bold text** 转换为 VT100 编码字符串，并在 VT100EncodedString 属性中可用。

参数

-AsVT100EncodedString

指定输出是否应编码为具有 VT100 转义代码的字符串。

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

指定要转换的对象。 指定 System.String 类型的对象时，会转换字符串。 指定 System.IO.FileInfo 类型的对象时，会转换对象指定的文件的内容。 任何其他类型的对象都会导致错误。

Type:PSObject
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-LiteralPath

指定要转换的文件的路径。

Type:String[]
Aliases:PSPath, LP
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Path

指定要转换的文件的路径。

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:True

输入

PSObject

输出

Microsoft.PowerShell.MarkdownRender.MarkdownInfo