ConvertFrom-Markdown
Convierta el contenido de una cadena o un archivo en un objeto MarkdownInfo.
Sintaxis
PathParamSet (Es el valor predeterminado).
ConvertFrom-Markdown
[-Path] <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
LiteralParamSet
ConvertFrom-Markdown
-LiteralPath <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
InputObjParamSet
ConvertFrom-Markdown
-InputObject <PSObject>
[-AsVT100EncodedString]
[<CommonParameters>]
Description
Este cmdlet convierte el contenido especificado en un MarkdownInfo. Cuando se especifica una ruta de acceso de archivo para el parámetro Path, se convierte el contenido del archivo. El objeto de salida tiene tres propiedades:
- La propiedad del token
tiene el árbol sintáctico abstracto (AST) del objeto convertido. - La propiedad Html tiene la conversión HTML de la entrada especificada.
- La propiedad VT100EncodedString tiene la cadena convertida con secuencias de escape ANSI (VT100) si se especificó el parámetro AsVT100EncodedString
Este cmdlet se introdujo en PowerShell 6.1.
Ejemplos
Ejemplo 1: Conversión de un archivo que contiene contenido de Markdown en HTML
ConvertFrom-Markdown -Path .\README.md
Se devuelve el objeto MarkdownInfo. La propiedad Tokens tiene el AST del contenido convertido del archivo README.md. La propiedad Html tiene el contenido convertido de HTML del archivo README.md.
Ejemplo 2: Conversión de un archivo que contiene contenido de Markdown a una cadena codificada en VT100
ConvertFrom-Markdown -Path .\README.md -AsVT100EncodedString
Se devuelve el objeto MarkdownInfo. La propiedad Tokens tiene el AST del contenido convertido del archivo README.md. La propiedad VT100EncodedString tiene el contenido convertido de la cadena codificada con VT100 del archivo README.md.
Ejemplo 3: Convertir el objeto de entrada que contiene contenido de Markdown a una cadena codificada en VT100
Get-Item .\README.md | ConvertFrom-Markdown -AsVT100EncodedString
Se devuelve el objeto MarkdownInfo. El objeto FileInfo de Get-Item se convierte en una cadena codificada con VT100. La propiedad Tokens tiene el AST del contenido convertido del archivo README.md. La propiedad VT100EncodedString tiene el contenido convertido de la cadena codificada con VT100 del archivo README.md.
Ejemplo 4: Convertir una cadena que contiene contenido de Markdown en una cadena codificada en VT100
"**Bold text**" | ConvertFrom-Markdown -AsVT100EncodedString
Se devuelve el objeto MarkdownInfo. La cadena especificada **Bold text** se convierte en una cadena codificada VT100 y está disponible en la propiedad VT100EncodedString.
Parámetros
-AsVT100EncodedString
Especifica si la salida se debe codificar como una cadena con códigos de escape VT100.
Propiedades del parámetro
| Tipo: | SwitchParameter |
| Valor predeterminado: | None |
| 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 |
-InputObject
Especifica el objeto que se va a convertir. Cuando se especifica un objeto de tipo System.String, se convierte la cadena. Cuando se especifica un objeto de tipo System.IO.FileInfo, se convierte el contenido del archivo especificado por el objeto. Los objetos de cualquier otro tipo producen un error.
Propiedades del parámetro
| Tipo: | PSObject |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
Conjuntos de parámetros
InputObjParamSet
| 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 una ruta de acceso al archivo que se va a convertir.
Propiedades del parámetro
| Tipo: | String[] |
| Valor predeterminado: | None |
| Admite caracteres comodín: | False |
| DontShow: | False |
| Alias: | PSPath, LP |
Conjuntos de parámetros
LiteralParamSet
| Posición: | Named |
| Mandatory: | True |
| Valor de la canalización: | False |
| Valor de la canalización por nombre de propiedad: | False |
| Valor de los argumentos restantes: | False |
-Path
Especifica una ruta de acceso al archivo que se va a convertir.
Propiedades del parámetro
| Tipo: | String[] |
| Valor predeterminado: | None |
| Admite caracteres comodín: | True |
| DontShow: | False |
Conjuntos de parámetros
PathParamSet
| Posición: | 0 |
| Mandatory: | True |
| 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.
