ConvertFrom-Markdown (Microsoft.PowerShell.Utility)

ConvertFrom-Markdown

Модуль:: Microsoft.PowerShell.Utility

Преобразуйте содержимое строки или файла в объект MarkdownInfo.

Синтаксис

ConvertFrom-Markdown
                [-Path] <String[]>
                [-AsVT100EncodedString]
                [<CommonParameters>]

ConvertFrom-Markdown
                -LiteralPath <String[]>
                [-AsVT100EncodedString]
                [<CommonParameters>]

ConvertFrom-Markdown
                -InputObject <PSObject>
                [-AsVT100EncodedString]
                [<CommonParameters>]

Описание

Этот командлет преобразует указанное содержимое в MarkdownInfo. Если для параметра Path указан путь к файлу, содержимое файла преобразуется. Выходной объект имеет три свойства:

Свойство Token содержит абстрактное синтаксическое дерево (AST) преобразованного объекта.
Свойство Html выполняет преобразование HTML указанного ввода.
Свойство VT100EncodedString содержит преобразованную строку с escape-последовательностями ANSI (VT100), если был указан параметр AsVT100EncodedString.

Этот командлет был представлен в PowerShell 6.1.

Примеры

Пример 1. Преобразование файла, содержащего содержимое Markdown, в HTML.

ConvertFrom-Markdown -Path .\README.md

Возвращается объект MarkdownInfo. Свойство Tokens содержит AST преобразованного содержимого файла README.md. Свойство Html содержит преобразованное в HTML содержимое файла README.md.

Пример 2. Преобразование файла, содержащего содержимое Markdown, в строку в кодировке VT100.

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

Возвращается объект MarkdownInfo. Свойство Tokens содержит AST преобразованного содержимого файла README.md. Свойство VT100EncodedString содержит преобразованное содержимое строки в кодировке VT100 файла README.md.

Пример 3. Преобразование входного объекта, содержащего содержимое Markdown, в строку в кодировке VT100.

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

Возвращается объект MarkdownInfo. Объект FileInfo из Get-Item преобразуется в строку, закодированную VT100. Свойство Tokens содержит AST преобразованного содержимого файла README.md. Свойство VT100EncodedString содержит преобразованное содержимое строки в кодировке VT100 файла README.md.

Пример 4. Преобразование строки, содержащей содержимое Markdown, в строку в кодировке VT100.

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

Возвращается объект MarkdownInfo. Указанная строка **Жирный текст** преобразуется в строку, закодированную VT100, и доступна в свойстве VT100EncodedString.

Параметры

-AsVT100EncodedString

Указывает, должен ли вывод быть закодирован как строка с escape-кодами VT100.

Тип :: SwitchParameter
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: False
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-InputObject

Указывает объект для преобразования. Если указан объект типа System.String, строка преобразуется. Если указан объект типа System.IO.FileInfo, содержимое файла, указанного этим объектом, преобразуется. Объекты любого другого типа приводят к ошибке.

Тип :: PSОбъект
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: True
Примите ввод конвейера:: True
Принимайте подстановочные знаки:: False

-LiteralPath

Указывает путь к файлу, который необходимо преобразовать.

Тип :: String[]
Псевдонимы:: PSPath, LP
Позиция:: Именованный
Значение по умолчанию:: None
Необходимый:: True
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: False

-Path

Указывает путь к файлу, который необходимо преобразовать.

Тип :: String[]
Позиция:: 0
Значение по умолчанию:: None
Необходимый:: True
Примите ввод конвейера:: False
Принимайте подстановочные знаки:: True

Входы

PSObject

Выходы

Microsoft.PowerShell.MarkdownRender.MarkdownInfo