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

Type:	PSObject
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-LiteralPath

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

Type:	String[]
Aliases:	PSPath, LP
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

-Path

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

Type:	String[]
Position:	0
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	True

-UseBrowser

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

Type:	SwitchParameter
Position:	Named
Default value:	False
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

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

PSObject

String[]

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

String

ConvertFrom-Markdown