ConvertFrom-Markdown
Convertissez le contenu d’une chaîne ou d’un fichier en objet MarkdownInfo .
Syntax
ConvertFrom-Markdown
[-Path] <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
ConvertFrom-Markdown
-LiteralPath <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
ConvertFrom-Markdown
-InputObject <PSObject>
[-AsVT100EncodedString]
[<CommonParameters>]
Description
Cette applet de commande convertit le contenu spécifié en MarkdownInfo. Lorsqu’un chemin d’accès de fichier est spécifié pour le paramètre Path , le contenu du fichier est converti. L’objet de sortie a trois propriétés :
- La propriété Token a l’arborescence de syntaxe abstraite (AST) de l’objet converti
- La propriété Html a la conversion HTML de l’entrée spécifiée
- La propriété VT100EncodedString a la chaîne convertie avec des séquences d’échappement ANSI (VT100) si le paramètre AsVT100EncodedString a été spécifié
Cette applet de commande a été introduite dans PowerShell 6.1.
Exemples
Exemple 1 : Convertir un fichier contenant du contenu Markdown au format HTML
ConvertFrom-Markdown -Path .\README.md
L’objet MarkdownInfo est retourné. La propriété Tokens a l’AST du contenu converti du README.md
fichier. La propriété Html a le contenu converti HTML du README.md
fichier.
Exemple 2 : Convertir un fichier contenant du contenu Markdown en chaîne encodée VT100
ConvertFrom-Markdown -Path .\README.md -AsVT100EncodedString
L’objet MarkdownInfo est retourné. La propriété Tokens a l’AST du contenu converti du README.md
fichier. La propriété VT100EncodedString a le contenu converti de chaîne encodée VT100 du README.md
fichier.
Exemple 3 : Convertir un objet d’entrée contenant du contenu Markdown en chaîne encodée VT100
Get-Item .\README.md | ConvertFrom-Markdown -AsVT100EncodedString
L’objet MarkdownInfo est retourné. L’objet FileInfo de Get-Item
est converti en chaîne encodée VT100. La propriété Tokens a l’AST du contenu converti du README.md
fichier. La propriété VT100EncodedString a le contenu converti de chaîne encodée VT100 du README.md
fichier.
Exemple 4 : Convertir une chaîne contenant du contenu Markdown en chaîne encodée VT100
"**Bold text**" | ConvertFrom-Markdown -AsVT100EncodedString
L’objet MarkdownInfo est retourné. La chaîne **Bold text**
spécifiée est convertie en chaîne encodée VT100 et disponible dans la propriété VT100EncodedString .
Paramètres
-AsVT100EncodedString
Spécifie si la sortie doit être encodée en tant que chaîne avec des codes d’échappement VT100.
Type: | SwitchParameter |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-InputObject
Spécifie l'objet à convertir. Lorsqu’un objet de type System.String est spécifié, la chaîne est convertie. Lorsqu’un objet de type System.IO.FileInfo est spécifié, le contenu du fichier spécifié par l’objet est converti. Les objets de tout autre type entraînent une erreur.
Type: | PSObject |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-LiteralPath
Spécifie un chemin d’accès au fichier à convertir.
Type: | String[] |
Aliases: | PSPath, LP |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-Path
Spécifie un chemin d’accès au fichier à convertir.
Type: | String[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | False |
Accept wildcard characters: | True |
Entrées
Sorties
Microsoft.PowerShell.MarkdownRender.MarkdownInfo