Show-Markdown
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
Path (Padrão)
Show-Markdown
[-Path] <String[]>
[-UseBrowser]
[<CommonParameters>]
InputObject
Show-Markdown
-InputObject <PSObject>
[-UseBrowser]
[<CommonParameters>]
LiteralPath
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.
Propriedades do parâmetro
| Tipo: | PSObject |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
InputObject
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | 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 caractere curinga. Se o caminho incluir caracteres de escape, coloque-o entre aspas simples. Aspas simples indicam ao PowerShell que não deve interpretar nenhum caractere como uma sequência de escape.
Propriedades do parâmetro
| Tipo: | String[] |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | PSPath, LP |
Conjuntos de parâmetros
LiteralPath
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-Path
Especifica o caminho para um arquivo Markdown a ser renderizado.
Propriedades do parâmetro
| Tipo: | String[] |
| Valor padrão: | None |
| Dá suporte a curingas: | True |
| DontShow: | False |
Conjuntos de parâmetros
Path
| Cargo: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | True |
| Valor dos argumentos restantes: | False |
-UseBrowser
Compila a entrada markdown como HTML e a abre no navegador padrão.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | False |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.
