ConvertFrom-Markdown
Converta o conteúdo de uma cadeia de caracteres ou um arquivo em um objeto MarkdownInfo.
Sintaxe
PathParamSet (Predefinição)
ConvertFrom-Markdown
[-Path] <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
LiteralParamSet
ConvertFrom-Markdown
-LiteralPath <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
InputObjParamSet
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 tiver sido 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 arquivo README.md. A propriedade Html tem o conteúdo HTML convertido do arquivo README.md.
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 arquivo README.md. A propriedade VT100EncodedString tem a cadeia de caracteres codificada em VT100 convertido o conteúdo do ficheiro README.md.
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 do 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 a cadeia de caracteres codificada em VT100 convertido o conteúdo do ficheiro 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 string especificada **Bold text** é convertida numa string codificada 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.
Propriedades dos parâmetros
| Tipo: | SwitchParameter |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
(All)
| Position: | Named |
| Obrigatório: | False |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | 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 dos parâmetros
| Tipo: | PSObject |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
Conjuntos de parâmetros
InputObjParamSet
| Position: | Named |
| Obrigatório: | True |
| Valor do pipeline: | True |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-LiteralPath
Especifica um caminho para o arquivo a ser convertido.
Propriedades dos parâmetros
| Tipo: | String[] |
| Default value: | None |
| Suporta carateres universais: | False |
| NãoMostrar: | False |
| Aliases: | PSPath, LP |
Conjuntos de parâmetros
LiteralParamSet
| Position: | Named |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | False |
-Path
Especifica um caminho para o arquivo a ser convertido.
Propriedades dos parâmetros
| Tipo: | String[] |
| Default value: | None |
| Suporta carateres universais: | True |
| NãoMostrar: | False |
Conjuntos de parâmetros
PathParamSet
| Position: | 0 |
| Obrigatório: | True |
| Valor do pipeline: | False |
| Valor do pipeline por nome de propriedade: | False |
| Valor dos restantes argumentos: | 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.
