Show-Markdown
Muestra un archivo o una cadena de Markdown en la consola de una manera fácil de usar secuencias de escape VT100 o en un explorador mediante HTML.
Syntax
Show-Markdown
[-Path] <String[]>
[-UseBrowser]
[<CommonParameters>]
Show-Markdown
-InputObject <PSObject>
[-UseBrowser]
[<CommonParameters>]
Show-Markdown
-LiteralPath <String[]>
[-UseBrowser]
[<CommonParameters>]
Description
El Show-Markdown
cmdlet se usa para representar Markdown en un formato legible humano, ya sea en un terminal o en un explorador.
Show-Markdown
puede devolver una cadena que incluya las secuencias de escape VT100 que representa el terminal (si admite secuencias de escape VT100). Esto se usa principalmente para ver archivos Markdown en un terminal. También puede obtener esta cadena mediante la ConvertFrom-Markdown
especificación del parámetro AsVT100EncodedString .
Show-Markdown
también tiene la capacidad de abrir un explorador y mostrar una versión representada de Markdown. Representa el Markdown convirtiéndolo en HTML y abriendo el archivo HTML en el explorador predeterminado.
Puede cambiar cómo Show-Markdown
representa Markdown en un terminal mediante Set-MarkdownOption
.
Este cmdlet se introdujo en PowerShell 6.1.
Ejemplos
Ejemplo 1: Ejemplo sencillo de especificación de una ruta de acceso
Show-Markdown -Path ./README.md
Ejemplo 2: Ejemplo simple de especificación de una cadena
@"
# Show-Markdown
## Markdown
You can now interact with Markdown via PowerShell!
*stars*
__underlines__
"@ | Show-Markdown
Ejemplo 2: Abrir Markdown en un explorador
Show-Markdown -Path ./README.md -UseBrowser
Parámetros
-InputObject
Cadena de Markdown que se mostrará en el terminal. Si no pasa un formato admitido, Show-Markdown
emitirá un error.
Type: | PSObject |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-LiteralPath
Especifica la ruta de acceso a un archivo Markdown. A diferencia del parámetro Path, el valor de LiteralPath se usa exactamente como se escribe. Ninguno de los caracteres se interpreta como caracteres comodín. Si la ruta de acceso contiene caracteres de escape, escríbalos entre comillas simples. Las comillas simples indican a PowerShell que no interprete ningún carácter como secuencias de escape.
Type: | String[] |
Aliases: | PSPath, LP |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Path
Especifica la ruta de acceso a un archivo Markdown que se va a representar.
Type: | String[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | True |
-UseBrowser
Compila la entrada de Markdown como HTML y la abre en el explorador predeterminado.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Entradas
String[]