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.
Sintaxis
Path (Es el valor predeterminado).
Show-Markdown
[-Path] <String[]>
[-UseBrowser]
[<CommonParameters>]
InputObject
Show-Markdown
-InputObject <PSObject>
[-UseBrowser]
[<CommonParameters>]
LiteralPath
Show-Markdown
-LiteralPath <String[]>
[-UseBrowser]
[<CommonParameters>]
Description
El cmdlet Show-Markdown se usa para representar Markdown en un formato legible, 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 a través del ConvertFrom-Markdown especificando el parámetro AsVT100EncodedString.
Show-Markdown también tiene la capacidad de abrir un explorador y mostrar una versión representada de Markdown. Representa markdown al convertirlo en HTML y abrir 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 que especifica una ruta de acceso
Show-Markdown -Path ./README.md
Ejemplo 2: ejemplo sencillo que especifica 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 compatible, Show-Markdown emitirá un error.
Propiedades del parámetro
| Tipo: | PSObject |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
InputObject
| Posición: | Named |
| Mandatory: | True |
| Valor de la canalización: | True |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | 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 incluye caracteres de escape, escríbala entre comillas simples. Las comillas simples indican a PowerShell que no interprete ningún carácter como secuencias de escape.
Propiedades del parámetro
| Tipo: | String[] |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
| Alias: | PSPath, LP |
Conjuntos de parámetros
LiteralPath
| Posición: | Named |
| Mandatory: | True |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | True |
| Valor de los argumentos restantes: | False |
-Path
Especifica la ruta de acceso a un archivo Markdown que se va a representar.
Propiedades del parámetro
| Tipo: | String[] |
| Valor predeterminado: | None |
| Admite caracteres comodín: | True |
| DontShow: | False |
Conjuntos de parámetros
Path
| Posición: | 0 |
| Mandatory: | True |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | True |
| Valor de los argumentos restantes: | False |
-UseBrowser
Compila la entrada Markdown como HTML y la abre en el explorador predeterminado.
Propiedades del parámetro
| Tipo: | SwitchParameter |
| Valor predeterminado: | False |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
(All)
| Posición: | Named |
| Mandatory: | False |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
CommonParameters
Este cmdlet admite los parámetros comunes: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction y -WarningVariable. Para obtener más información, vea about_CommonParameters.
