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 выдаст ошибку.

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

-LiteralPath

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

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

-Path

Указывает путь к файлу Markdown для отрисовки.

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

-UseBrowser

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

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

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

PSObject

String[]

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

String