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-Item FileInfo преобразуется в строку в кодировке 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.

Тип:SwitchParameter
Position:Named
Default value:None
Обязательно:False
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-InputObject

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

Тип:PSObject
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:True
Принять подстановочные знаки:False

-LiteralPath

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

Тип:String[]
Aliases:PSPath, LP
Position:Named
Default value:None
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:False

-Path

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

Тип:String[]
Position:0
Default value:None
Обязательно:True
Принять входные данные конвейера:False
Принять подстановочные знаки:True

Входные данные

PSObject

Выходные данные

Microsoft.PowerShell.MarkdownRender.MarkdownInfo