Show-Markdown
Affiche un fichier ou une chaîne Markdown dans la console de manière conviviale à l’aide de séquences d’échappement VT100 ou dans un navigateur à l’aide de HTML.
Syntaxe
Path (Par défaut)
Show-Markdown
[-Path] <String[]>
[-UseBrowser]
[<CommonParameters>]
InputObject
Show-Markdown
-InputObject <PSObject>
[-UseBrowser]
[<CommonParameters>]
LiteralPath
Show-Markdown
-LiteralPath <String[]>
[-UseBrowser]
[<CommonParameters>]
Description
L’applet de commande Show-Markdown est utilisée pour afficher Markdown dans un format lisible par l’homme dans un terminal ou dans un navigateur.
Show-Markdown pouvez retourner une chaîne qui inclut les séquences d’échappement VT100 que le terminal affiche (s’il prend en charge les séquences d’échappement VT100). Cela est principalement utilisé pour afficher les fichiers Markdown dans un terminal. Vous pouvez également obtenir cette chaîne via le ConvertFrom-Markdown en spécifiant le paramètre AsVT100EncodedString.
Show-Markdown a également la possibilité d’ouvrir un navigateur et de vous afficher une version rendue de Markdown. Il restitue le Markdown en le transformant en HTML et en ouvrant le fichier HTML dans votre navigateur par défaut.
Vous pouvez modifier la façon dont Show-Markdown restitue Markdown dans un terminal à l’aide de Set-MarkdownOption.
Cette applet de commande a été introduite dans PowerShell 6.1.
Exemples
Exemple 1 : Exemple simple spécifiant un chemin d’accès
Show-Markdown -Path ./README.md
Exemple 2 : Exemple simple spécifiant une chaîne
@"
# Show-Markdown
## Markdown
You can now interact with Markdown via PowerShell!
*stars*
__underlines__
"@ | Show-Markdown
Exemple 2 : Ouverture de Markdown dans un navigateur
Show-Markdown -Path ./README.md -UseBrowser
Paramètres
-InputObject
Chaîne Markdown qui sera affichée dans le terminal. Si vous ne transmettez pas un format pris en charge, Show-Markdown émettra 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
InputObject
| 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 le chemin d’accès à un fichier Markdown. Contrairement au paramètre Path, la valeur de LiteralPath est utilisée exactement comme elle est typée. Aucun caractère n’est interprété en tant que caractère générique. Si le chemin d’accès inclut des caractères d’échappement, mettez-le entre des guillemets simples. Les guillemets simples indiquent à PowerShell de ne pas interpréter de caractères comme séquences d’échappement.
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
LiteralPath
| Position: | Named |
| Obligatoire: | True |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | True |
| Valeur des arguments restants: | False |
-Path
Spécifie le chemin d’accès à un fichier Markdown à afficher.
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
Path
| Position: | 0 |
| Obligatoire: | True |
| Valeur du pipeline: | False |
| Valeur du pipeline par nom de propriété: | True |
| Valeur des arguments restants: | False |
-UseBrowser
Compile l’entrée Markdown en tant que code HTML et l’ouvre dans votre navigateur par défaut.
Propriétés du paramètre
| Type: | SwitchParameter |
| Valeur par défaut: | False |
| 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 |
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.
