ConvertFrom-Markdown
Converta o conteúdo de uma cadeia de caracteres ou um arquivo em um objeto MarkdownInfo.
Sintaxe
PathParamSet (Padrão)
ConvertFrom-Markdown
[-Path] <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
LiteralParamSet
ConvertFrom-Markdown
-LiteralPath <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
InputObjParamSet
ConvertFrom-Markdown
-InputObject <PSObject>
[-AsVT100EncodedString]
[<CommonParameters>]
Description
Esse cmdlet converte o conteúdo especificado em um MarkdownInfo. Quando um caminho de arquivo é especificado para o parâmetro Path, o conteúdo no 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
Esse cmdlet foi introduzido no PowerShell 6.1.
Exemplos
Exemplo 1: converter um arquivo que contém o 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 arquivo README.md. A propriedade html tem o conteúdo convertido em HTML do arquivo README.md.
Exemplo 2: converter um arquivo que contém o 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 arquivo README.md. A propriedade VT100EncodedString tem o conteúdo convertido da cadeia de caracteres codificada em VT100 do arquivo README.md.
Exemplo 3: Converter o objeto de entrada que contém o conteúdo de Markdown em uma cadeia de caracteres codificada em VT100
Get-Item .\README.md | ConvertFrom-Markdown -AsVT100EncodedString
O objeto MarkdownInfo é retornado. O objeto FileInfo de Get-Item é convertido em uma cadeia de caracteres codificada em VT100. A propriedade Tokens tem o AST do conteúdo convertido do arquivo README.md. A propriedade VT100EncodedString tem o conteúdo convertido da cadeia de caracteres codificada em VT100 do arquivo README.md.
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 especificada **Bold text** é convertida em uma cadeia de caracteres codificada em VT100 e disponível em propriedade VT100EncodedString.
Parâmetros
-AsVT100EncodedString
Especifica se a saída deve ser codificada como uma cadeia de caracteres com códigos de escape VT100.
Propriedades do parâmetro
| Tipo: | SwitchParameter |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
(All)
| Cargo: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | 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.
Propriedades do parâmetro
| Tipo: | PSObject |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
Conjuntos de parâmetros
InputObjParamSet
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-LiteralPath
Especifica um caminho para o arquivo a ser convertido.
Propriedades do parâmetro
| Tipo: | String[] |
| Valor padrão: | None |
| Dá suporte a curingas: | False |
| DontShow: | False |
| Aliases: | PSPath, LP |
Conjuntos de parâmetros
LiteralParamSet
| Cargo: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
-Path
Especifica um caminho para o arquivo a ser convertido.
Propriedades do parâmetro
| Tipo: | String[] |
| Valor padrão: | None |
| Dá suporte a curingas: | True |
| DontShow: | False |
Conjuntos de parâmetros
PathParamSet
| Cargo: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline pelo nome da propriedade: | False |
| Valor dos argumentos restantes: | False |
CommonParameters
Este cmdlet suporta os parâmetros comuns: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction e -WarningVariable. Para obter mais informações, consulte about_CommonParameters.
