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 . Свойство Token имеет AST преобразованного содержимого README.md файла. Свойство Html содержит преобразованное HTML-содержимое README.md файла.

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

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

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

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

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

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

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

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

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

Параметры

-AsVT100EncodedString

Указывает, следует ли кодировать выходные данные в виде строки с escape-кодами 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