Show-Markdown
Mostra um arquivo Markdown ou string no console de forma amigável usando sequências de escape VT100 ou em um navegador usando HTML.
Sintaxe
Path (Predefiniçã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 por humanos 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 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-lhe 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 como Show-Markdown renderiza Markdown em um terminal usando Set-MarkdownOption.
Este 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.
Propriedades dos parâmetros
| Tipo: | PSObject |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
InputObject
| Position: | Named |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | 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 carta curinga. Se o caminho incluir caracteres de escape, coloque-o entre aspas simples. Aspas simples indicam ao PowerShell para não interpretar quaisquer caracteres como sequências de escape.
Propriedades dos parâmetros
| Tipo: | String[] |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | PSPath, LP |
Conjuntos de parâmetros
LiteralPath
| Position: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | True |
| Valor dos restantes argumentos: | False |
-Path
Especifica o caminho para um arquivo Markdown a ser renderizado.
Propriedades dos parâmetros
| Tipo: | String[] |
| Default value: | None |
| Suporta carateres universais: | True |
| NãoMostrar: | False |
Conjuntos de parâmetros
Path
| Position: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | True |
| Valor dos restantes argumentos: | False |
-UseBrowser
Compila a entrada Markdown como HTML e abre-a no seu navegador padrão.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | False |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | 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.
