Compartilhar via

Show-Markdown

  • Referência
Módulo:
Microsoft.PowerShell.Utility

Mostra um arquivo Markdown ou string no console de maneira 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 Show-Markdown cmdlet é usado para renderizar Markdown em um formato legível por humanos em um terminal ou em um navegador.

Show-Markdown pode retornar uma string que inclui as sequências de escape VT100 que o terminal renderiza (se ele suportar sequências de escape VT100). Isso é usado principalmente para visualizar 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 em seu navegador padrão.

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

Esse cmdlet foi introduzido no PowerShell 6.1.

Exemplos

Exemplo 1: Exemplo simples especificando um caminho

Show-Markdown -Path ./README.md

Exemplo 2: exemplo simples especificando uma cadeia de caracteres

@"
# Show-Markdown

## Markdown

You can now interact with Markdown via PowerShell!

*stars*
__underlines__
"@ | Show-Markdown

Exemplo 2: Abrindo Markdown em um navegador

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

Parâmetros

-InputObject

Uma string Markdown que será mostrada no terminal. Se você não passar em um formato suportado, 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 é digitado. Nenhum caractere é interpretado como caractere curinga. Se o caminho incluir caracteres de escape, coloque-o entre aspas simples. As aspas simples informam 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