Show-Markdown
Отображает файл Markdown или строку в консоли понятным способом с помощью escape-последовательностей VT100 или в браузере с помощью HTML.
Синтаксис
Path (по умолчанию)
Show-Markdown
[-Path] <String[]>
[-UseBrowser]
[<CommonParameters>]
InputObject
Show-Markdown
-InputObject <PSObject>
[-UseBrowser]
[<CommonParameters>]
LiteralPath
Show-Markdown
-LiteralPath <String[]>
[-UseBrowser]
[<CommonParameters>]
Описание
Командлет Show-Markdown используется для форматирования Markdown в человекочитаемом формате в терминале или в браузере.
Show-Markdown может возвращать строку, включающую последовательности управления VT100, которые терминал отображает (если он поддерживает последовательности управления VT100). Это в основном используется для просмотра файлов Markdown в терминале. Эту строку можно также получить с помощью ConvertFrom-Markdown, указав параметр AsVT100EncodedString.
Show-Markdown также имеет возможность открыть браузер и отобразить отрисованную версию Markdown. Он обрабатывает Markdown, превращая его в HTML-файл и открывает HTML-файл в браузере по умолчанию.
Вы можете изменить способ отображения Markdown в терминале Show-Markdown с помощью Set-MarkdownOption.
Этот командлет был введён в PowerShell 6.1.
Примеры
Пример 1. Простой пример, указывающий путь
Show-Markdown -Path ./README.md
Пример 2. Простой пример, указывающий строку
@"
# Show-Markdown
## Markdown
You can now interact with Markdown via PowerShell!
*stars*
__underlines__
"@ | Show-Markdown
Пример 2. Открытие Markdown в браузере
Show-Markdown -Path ./README.md -UseBrowser
Параметры
-InputObject
Строка Markdown, которая будет отображаться в терминале. Если вы не передаете поддерживаемый формат, Show-Markdown выдает ошибку.
Свойства параметра
| Тип: | PSObject |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
InputObject
| Position: | Named |
| Обязательно: | True |
| Значение из конвейера: | True |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
-LiteralPath
Указывает путь к файлу Markdown. В отличие от параметра Path, значение LiteralPath используется точно в том виде, как оно введено. Никакие символы не интерпретируются как подстановочные знаки. Если путь содержит escape-символы, заключите его в одинарные кавычки. Одинарные кавычки указывают PowerShell на то, что не следует интерпретировать какие-либо символы как управляющие последовательности.
Свойства параметра
| Тип: | String[] |
| Default value: | None |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
| Aliases: | PSPath, LP |
Наборы параметров
LiteralPath
| Position: | Named |
| Обязательно: | True |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | True |
| Значение из оставшихся аргументов: | False |
-Path
Указывает путь к файлу Markdown для отрисовки.
Свойства параметра
| Тип: | String[] |
| Default value: | None |
| Поддерживаются подстановочные знаки: | True |
| DontShow: | False |
Наборы параметров
Path
| Position: | 0 |
| Обязательно: | True |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | True |
| Значение из оставшихся аргументов: | False |
-UseBrowser
Компилирует входные данные Markdown в формате HTML и открывает его в браузере по умолчанию.
Свойства параметра
| Тип: | SwitchParameter |
| Default value: | False |
| Поддерживаются подстановочные знаки: | False |
| DontShow: | False |
Наборы параметров
(All)
| Position: | Named |
| Обязательно: | False |
| Значение из конвейера: | False |
| Значение из конвейера по имени свойства: | False |
| Значение из оставшихся аргументов: | False |
CommonParameters
Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.
