ConvertFrom-Markdown

  • Referência
Módulo:
Microsoft.PowerShell.Utility

Converta o conteúdo de uma cadeia de caracteres ou um arquivo em um objeto MarkdownInfo .

Sintaxe

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

Description

Este cmdlet converte o conteúdo especificado em um MarkdownInfo. Quando um caminho de arquivo é especificado para o parâmetro Path , o conteúdo do arquivo é convertido. O objeto de saída tem três propriedades:

  • A propriedade Token tem a árvore de sintaxe abstrata (AST) do objeto convertido
  • A propriedade Html tem a conversão HTML da entrada especificada
  • A propriedade VT100EncodedString tem a cadeia de caracteres convertida com sequências de escape ANSI (VT100) se o parâmetro AsVT100EncodedString foi especificado

Este cmdlet foi introduzido no PowerShell 6.1.

Exemplos

Exemplo 1: Converter um arquivo que contém conteúdo de Markdown em HTML

ConvertFrom-Markdown -Path .\README.md

O objeto MarkdownInfo é retornado. A propriedade Tokens tem o AST do conteúdo convertido do README.md arquivo. A propriedade Html tem o conteúdo HTML convertido do README.md arquivo.

Exemplo 2: Converter um arquivo que contém conteúdo de Markdown em uma cadeia de caracteres codificada em VT100

ConvertFrom-Markdown -Path .\README.md -AsVT100EncodedString

O objeto MarkdownInfo é retornado. A propriedade Tokens tem o AST do conteúdo convertido do README.md arquivo. A propriedade VT100EncodedString tem a cadeia de caracteres codificada VT100 converteu o README.md conteúdo do arquivo.

Exemplo 3: Converter objeto de entrada contendo conteúdo Markdown em uma cadeia de caracteres codificada em VT100

Get-Item .\README.md | ConvertFrom-Markdown -AsVT100EncodedString

O objeto MarkdownInfo é retornado. O objeto FileInfo de é convertido em uma cadeia de caracteres codificada Get-Item em VT100. A propriedade Tokens tem o AST do conteúdo convertido do README.md arquivo. A propriedade VT100EncodedString tem a cadeia de caracteres codificada VT100 converteu o README.md conteúdo do arquivo.

Exemplo 4: Converter uma cadeia de caracteres que contém conteúdo Markdown em uma cadeia de caracteres codificada em VT100

"**Bold text**" | ConvertFrom-Markdown -AsVT100EncodedString

O objeto MarkdownInfo é retornado. A cadeia de caracteres **Bold text** especificada é convertida em uma cadeia de caracteres codificada em VT100 e está disponível na propriedade VT100EncodedString .

Parâmetros

-AsVT100EncodedString

Especifica se a saída deve ser codificada como uma cadeia de caracteres com códigos de escape VT100.

Tipo:SwitchParameter
Position:Named
Default value:None
Necessário:False
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-InputObject

Especifica o objeto a ser convertido. Quando um objeto do tipo System.String é especificado, a cadeia de caracteres é convertida. Quando um objeto do tipo System.IO.FileInfo é especificado, o conteúdo do arquivo especificado pelo objeto é convertido. Objetos de qualquer outro tipo resultam em um erro.

Tipo:PSObject
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:True
Aceitar carateres universais:False

-LiteralPath

Especifica um caminho para o arquivo a ser convertido.

Tipo:String[]
Aliases:PSPath, LP
Position:Named
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:False

-Path

Especifica um caminho para o arquivo a ser convertido.

Tipo:String[]
Position:0
Default value:None
Necessário:True
Aceitar entrada de pipeline:False
Aceitar carateres universais:True

Entradas

PSObject

Saídas

Microsoft.PowerShell.MarkdownRender.MarkdownInfo