ConvertFrom-Markdown
Converta o conteúdo de uma cadeia de caracteres ou um arquivo em um objeto MarkdownInfo .
Syntax
ConvertFrom-Markdown
[-Path] <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
ConvertFrom-Markdown
-LiteralPath <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
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 README.md
arquivo. A propriedade Html tem o conteúdo html convertido do README.md
arquivo.
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 README.md
arquivo. A propriedade VT100EncodedString tem a cadeia de caracteres codificada em VT100 convertida no conteúdo do README.md
arquivo.
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 README.md
arquivo. A propriedade VT100EncodedString tem a cadeia de caracteres codificada em VT100 convertida no conteúdo do README.md
arquivo.
Exemplo 4: converter uma cadeia de caracteres que contém o conteúdo de 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 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.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | 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.
Type: | PSObject |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-LiteralPath
Especifica um caminho para o arquivo a ser convertido.
Type: | String[] |
Aliases: | PSPath, LP |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Path
Especifica um caminho para o arquivo a ser convertido.
Type: | String[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | True |
Entradas
Saídas
Microsoft.PowerShell.MarkdownRender.MarkdownInfo