ConvertFrom-Markdown
Преобразуйте содержимое строки или файла в объект MarkdownInfo.
Синтаксис
PathParamSet (по умолчанию)
ConvertFrom-Markdown
[-Path] <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
LiteralParamSet
ConvertFrom-Markdown
-LiteralPath <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
InputObjParamSet
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. Свойство токенов README.md.
Пример 2. Преобразование файла, содержащего содержимое Markdown, в строку с кодировкой VT100
ConvertFrom-Markdown -Path .\README.md -AsVT100EncodedString
Возвращается объект MarkdownInfo. Свойство токенов README.md, преобразованное в строку с кодировкой VT100.
Пример 3. Преобразование входного объекта, содержащего содержимое Markdown, в строку с кодировкой VT100
Get-Item .\README.md | ConvertFrom-Markdown -AsVT100EncodedString
Возвращается объект MarkdownInfo. Объект FileInfo из Get-Item преобразуется в строку, кодированную в VT100. Свойство токенов README.md, преобразованное в строку с кодировкой VT100.
Пример 4. Преобразование строки, содержащей содержимое Markdown, в строку с кодировкой VT100
"**Bold text**" | ConvertFrom-Markdown -AsVT100EncodedString
Возвращается объект MarkdownInfo. Указанная строка **Bold text** преобразуется в строку в кодировке VT100 и доступна в свойстве VT100EncodedString.
Параметры
-AsVT100EncodedString
Указывает, следует ли кодировать выходные данные в виде строки с escape-кодами VT100.
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-InputObject
Указывает объект, который необходимо преобразовать. Если указан объект типа System.String, строка преобразуется. Если указан объект типа System.IO.FileInfo, содержимое файла, указанного объектом, преобразуется. Объекты любого другого типа приводят к ошибке.
Свойства параметра
| Тип: | PSObject |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
InputObjParamSet
| Position: | Named |
| Обязательно: | True |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-LiteralPath
Указывает путь к преобразованию файла.
Свойства параметра
| Тип: | String[] |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | PSPath, LP |
Наборы параметров
LiteralParamSet
| Position: | Named |
| Обязательно: | True |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-Path
Указывает путь к преобразованию файла.
Свойства параметра
| Тип: | String[] |
| Default value: | None |
| Поддерживаются подстановочные знаки: | True |
| DontShow: | False |
Наборы параметров
PathParamSet
| Position: | 0 |
| Обязательно: | True |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
CommonParameters
Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.
