ConvertFrom-Markdown
将字符串或文件的内容转换为 MarkdownInfo 对象。
语法
PathParamSet （默认值）
ConvertFrom-Markdown
[-Path] <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
LiteralParamSet
ConvertFrom-Markdown
-LiteralPath <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
InputObjParamSet
ConvertFrom-Markdown
-InputObject <PSObject>
[-AsVT100EncodedString]
[<CommonParameters>]
说明
此 cmdlet 将指定的内容转换为 MarkdownInfo。 为 Path 参数指定文件路径时，将转换文件上的内容。 输出对象具有三个属性：
- Token 属性具有已转换对象的抽象语法树 （AST）
- Html 属性具有指定输入的 HTML 转换
- 如果指定了 AsVT100EncodedString 参数，则 VT100EncodedString 属性具有具有 ANSI （VT100） 转义序列的转换字符串
PowerShell 6.1 中引入了此 cmdlet。
示例
示例 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 对象。
FileInfo 对象从 Get-Item 转换为 VT100 编码的字符串。
Tokens 属性具有已转换 README.md 文件的 AST 内容。
VT100EncodedString 属性具有 README.md 文件的 VT100 编码字符串转换内容。
示例 4：将包含 Markdown 内容的字符串转换为 VT100 编码的字符串
"**Bold text**" | ConvertFrom-Markdown -AsVT100EncodedString
返回 MarkdownInfo 对象。 指定的字符串 **Bold text** 转换为 VT100 编码的字符串，并在 VT100EncodedString 属性中可用。
参数
-AsVT100EncodedString
指定输出是否应编码为具有 VT100 转义代码的字符串。
参数属性
| 类型: | SwitchParameter |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-InputObject
指定要转换的对象。 指定 system.String 类型的对象时，将转换字符串。 指定 system.IO.FileInfo 类型的对象时，将转换对象指定的文件的内容。 任何其他类型的对象都会导致错误。
参数属性
| 类型: | PSObject |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
InputObjParamSet
| Position: | Named |
| 必需: | True |
| 来自管道的值: | True |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-LiteralPath
指定要转换的文件的路径。
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | PSPath, LP |
参数集
LiteralParamSet
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Path
指定要转换的文件的路径。
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | True |
| 不显示: | False |
参数集
PathParamSet
| Position: | 0 |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。
