ConvertFrom-Markdown
Convertissez le contenu d’une chaîne ou d’un fichier en objet MarkdownInfo.
Syntaxe
PathParamSet (Par défaut)
ConvertFrom-Markdown
[-Path] <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
LiteralParamSet
ConvertFrom-Markdown
-LiteralPath <String[]>
[-AsVT100EncodedString]
[<CommonParameters>]
InputObjParamSet
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 en HTML
ConvertFrom-Markdown -Path .\README.md
L’objet MarkdownInfo est retourné. La propriété Tokens contient l’AST du contenu converti du fichier README.md. La propriété HTML contient le contenu converti HTML du fichier README.md.
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 contient l’AST du contenu converti du fichier README.md. La propriété VT100EncodedString contient la chaîne encodée VT100 convertie du fichier README.md.
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 contient l’AST du contenu converti du fichier README.md. La propriété VT100EncodedString contient la chaîne encodée VT100 convertie du fichier README.md.
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 spécifiée **Bold text** est convertie en chaîne encodée VT100 et disponible dans 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.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
(All)
| Position: | Named |
| Obligatoire: | False |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | 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 d’un autre type entraînent une erreur.
Propriétés du paramètre
| Type: | PSObject |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
Jeux de paramètres
InputObjParamSet
| Position: | Named |
| Obligatoire: | True |
| Valeur du pipeline: | True |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-LiteralPath
Spécifie un chemin d’accès au fichier à convertir.
Propriétés du paramètre
| Type: | String[] |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | False |
| DontShow: | False |
| Alias: | PSPath, DP |
Jeux de paramètres
LiteralParamSet
| Position: | Named |
| Obligatoire: | True |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
-Path
Spécifie un chemin d’accès au fichier à convertir.
Propriétés du paramètre
| Type: | String[] |
| Valeur par défaut: | None |
| Prend en charge les caractères génériques: | True |
| DontShow: | False |
Jeux de paramètres
PathParamSet
| Position: | 0 |
| Obligatoire: | True |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | False |
| Valeur des arguments restants: | False |
CommonParameters
Cette applet de commande prend en charge les paramètres courants : -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction et -WarningVariable. Pour plus d’informations, consultez about_CommonParameters.
