Show-Markdown

Referência

Módulo:: Microsoft.PowerShell.Utility

Mostra um arquivo ou cadeia de caracteres markdown no console de forma amigável usando sequências de escape VT100 ou em um navegador usando HTML.

Sintaxe

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

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

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

Description

O cmdlet Show-Markdown é usado para renderizar Markdown em um formato legível humano em um terminal ou em um navegador.

Show-Markdown pode retornar uma cadeia de caracteres que inclui as sequências de escape VT100 que o terminal renderiza (se for compatível com sequências de escape VT100). Isso é usado principalmente para exibir arquivos Markdown em um terminal. Você também pode obter essa cadeia de caracteres por meio do ConvertFrom-Markdown especificando o parâmetro AsVT100EncodedString.

Show-Markdown também tem a capacidade de abrir um navegador e mostrar uma versão renderizada do Markdown. Ele renderiza o Markdown transformando-o em HTML e abrindo o arquivo HTML no navegador padrão.

Você pode alterar como Show-Markdown renderiza Markdown em um terminal usando Set-MarkdownOption.

Esse cmdlet foi introduzido no PowerShell 6.1.

Exemplos

Exemplo 1: exemplo simples que especifica um caminho

Show-Markdown -Path ./README.md

Exemplo 2: exemplo simples que especifica uma cadeia de caracteres

@"
# Show-Markdown

## Markdown

You can now interact with Markdown via PowerShell!

*stars*
__underlines__
"@ | Show-Markdown

Exemplo 2: Abrir Markdown em um navegador

Show-Markdown -Path ./README.md -UseBrowser

Parâmetros

-InputObject

Uma cadeia de caracteres Markdown que será mostrada no terminal. Se você não passar um formato com suporte, Show-Markdown emitirá um erro.

Tipo:	PSObject
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-LiteralPath

Especifica o caminho para um arquivo Markdown. Ao contrário do parâmetro Path, o valor de LiteralPath é usado exatamente como ele é digitado. Nenhum caractere é interpretado como curinga. Se o caminho incluir caracteres de escape, coloque-o entre aspas simples. As aspas simples dizem ao PowerShell para não interpretar nenhum caractere como sequências de escape.

Tipo:	String[]
Aliases:	PSPath, LP
Cargo:	Named
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	False

-Path

Especifica o caminho para um arquivo Markdown a ser renderizado.

Tipo:	String[]
Cargo:	0
Valor padrão:	None
Obrigatório:	True
Aceitar a entrada de pipeline:	True
Aceitar caracteres curinga:	True

-UseBrowser

Compila a entrada markdown como HTML e a abre no navegador padrão.

Tipo:	SwitchParameter
Cargo:	Named
Valor padrão:	False
Obrigatório:	False
Aceitar a entrada de pipeline:	False
Aceitar caracteres curinga:	False

Entradas

PSObject

String[]

Saídas

String

ConvertFrom-Markdown

Compartilhar via