ConvertFrom-Markdown

  • Referencia
Módulo:
Microsoft.PowerShell.Utility

Convierta el contenido de una cadena o un archivo en un objeto MarkdownInfo .

Syntax

ConvertFrom-Markdown
                [-Path] <String[]>
                [-AsVT100EncodedString]
                [<CommonParameters>]
ConvertFrom-Markdown
                -LiteralPath <String[]>
                [-AsVT100EncodedString]
                [<CommonParameters>]
ConvertFrom-Markdown
                -InputObject <PSObject>
                [-AsVT100EncodedString]
                [<CommonParameters>]

Description

Este cmdlet convierte el contenido especificado en 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 Token tiene el árbol de sintaxis abstracta (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 README.md archivo. La propiedad Html tiene el contenido convertido html del README.md archivo.

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 README.md archivo. La propiedad VT100EncodedString tiene el contenido convertido de la cadena con codificación VT100 del README.md archivo.

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 en VT100. La propiedad Tokens tiene el AST del contenido convertido del README.md archivo. La propiedad VT100EncodedString tiene el contenido convertido de la cadena con codificación VT100 del README.md archivo.

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 **Bold text** especificada se convierte en una cadena codificada en 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.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Especifica el objeto que se va a convertir. Cuando se especifica un objeto de tipo System.String , la cadena se convierte. 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.

Type:PSObject
Position:Named
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-LiteralPath

Especifica una ruta de acceso al archivo que se va a convertir.

Type:String[]
Aliases:PSPath, LP
Position:Named
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-Path

Especifica una ruta de acceso al archivo que se va a convertir.

Type:String[]
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:True

Entradas

PSObject

Salidas

Microsoft.PowerShell.MarkdownRender.MarkdownInfo