Show-Markdown (Microsoft.PowerShell.Utility)

Show-Markdown

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

Показывает файл или строку Markdown в консоли удобным способом с использованием escape-последовательностей VT100 или в браузере с использованием HTML.

Синтаксис

Show-Markdown
    [-Path] <String[]>
    [-UseBrowser]
    [<CommonParameters>]

Show-Markdown
    -InputObject <PSObject>
    [-UseBrowser]
    [<CommonParameters>]

Show-Markdown
    -LiteralPath <String[]>
    [-UseBrowser]
    [<CommonParameters>]

Описание

Командлет Show-Markdown используется для отображения Markdown в удобочитаемом формате либо в терминале, либо в браузере.

Show-Markdown может возвращать строку, включающую escape-последовательности VT100, отображаемые терминалом (если он поддерживает escape-последовательности VT100). В основном это используется для просмотра файлов Markdown в терминале. Эту строку также можно получить с помощью ConvertFrom-Markdown, указав параметр AsVT100EncodedString.

Show-Markdown также позволяет открыть браузер и показать вам обработанную версию Markdown. Он визуализирует Markdown, превращая его в HTML и открывая HTML-файл в браузере по умолчанию.

Вы можете изменить способ, которым Show-Markdown отображает 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 выдаст ошибку.

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

-LiteralPath

Указывает путь к файлу Markdown. В отличие от параметра Path, значение LiteralPath используется точно так, как оно введено. Никакие символы не интерпретируются как подстановочные знаки. Если путь содержит escape-символы, заключите его в одинарные кавычки. Одинарные кавычки сообщают PowerShell не интерпретировать никакие символы как escape-последовательности.

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

-Path

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

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

-UseBrowser

Компилирует входные данные Markdown в формате HTML и открывает их в браузере по умолчанию.

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

Входы

PSObject

Строка[]

Выходы

Строка