ConvertFrom-Markdown
Convertire il contenuto di una stringa o di un file in un oggetto MarkdownInfo .
Sintassi
ConvertFrom-Markdown
[-Path] <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
ConvertFrom-Markdown
-LiteralPath <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
ConvertFrom-Markdown
-InputObject <PSObject>
[-AsVT100EncodedString]
[<CommonParameters>]
Descrizione
Questo cmdlet converte il contenuto specificato in markdownInfo. Quando viene specificato un percorso file per il parametro Path , il contenuto del file viene convertito. L'oggetto output ha tre proprietà:
- La proprietà Token ha l'albero della sintassi astratta (AST) dell'oggetto convertito
- La proprietà Html ha la conversione HTML dell'input specificato
- La proprietà VT100EncodedString ha la stringa convertita con sequenze di escape ANSI (VT100) se è stato specificato il parametro AsVT100EncodedString
Questo cmdlet è stato introdotto in PowerShell 6.1.
Esempio
Esempio 1: Convertire un file contenente contenuto Markdown in HTML
ConvertFrom-Markdown -Path .\README.md
L'oggetto MarkdownInfo viene restituito. La proprietà Tokens dispone dell'AST del contenuto convertito del README.md
file. La proprietà Html ha il contenuto convertito HTML del README.md
file.
Esempio 2: Convertire un file contenente contenuto Markdown in una stringa con codifica VT100
ConvertFrom-Markdown -Path .\README.md -AsVT100EncodedString
L'oggetto MarkdownInfo viene restituito. La proprietà Tokens dispone dell'AST del contenuto convertito del README.md
file. La proprietà VT100EncodedString ha il contenuto convertito della stringa con codifica VT100 del README.md
file.
Esempio 3: Convertire l'oggetto di input contenente il contenuto markdown in una stringa con codifica VT100
Get-Item .\README.md | ConvertFrom-Markdown -AsVT100EncodedString
L'oggetto MarkdownInfo viene restituito. L'oggetto FileInfo da Get-Item
viene convertito in una stringa con codifica VT100. La proprietà Tokens dispone dell'AST del contenuto convertito del README.md
file. La proprietà VT100EncodedString ha il contenuto convertito della stringa con codifica VT100 del README.md
file.
Esempio 4: Convertire una stringa contenente contenuto Markdown in una stringa con codifica VT100
"**Bold text**" | ConvertFrom-Markdown -AsVT100EncodedString
L'oggetto MarkdownInfo viene restituito. La stringa specificata viene convertita in una stringa **Bold text**
con codifica VT100 e disponibile nella proprietà VT100EncodedString .
Parametri
-AsVT100EncodedString
Specifica se l'output deve essere codificato come stringa con codici di escape VT100.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Specifica l'oggetto da convertire. Quando viene specificato un oggetto di tipo System.String , la stringa viene convertita. Quando viene specificato un oggetto di tipo System.IO.FileInfo , il contenuto del file specificato dall'oggetto viene convertito. Gli oggetti di qualsiasi altro tipo generano un errore.
Type: | PSObject |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-LiteralPath
Specifica un percorso del file da convertire.
Type: | String[] |
Aliases: | PSPath, LP |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Path
Specifica un percorso del file da convertire.
Type: | String[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | True |
Input
Output
Microsoft.PowerShell.MarkdownRender.MarkdownInfo