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 du code HTML.
Syntax
Show-Markdown
[-Path] <String[]>
[-UseBrowser]
[<CommonParameters>]
Show-Markdown
-InputObject <PSObject>
[-UseBrowser]
[<CommonParameters>]
Show-Markdown
-LiteralPath <String[]>
[-UseBrowser]
[<CommonParameters>]
Description
L’applet Show-Markdown
de commande est utilisée pour restituer Markdown dans un format lisible par l’utilisateur dans un terminal ou dans un navigateur.
Show-Markdown
peut 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). Il est principalement utilisé pour afficher les fichiers Markdown dans un terminal. Vous pouvez également obtenir cette chaîne via en ConvertFrom-Markdown
spécifiant le paramètre AsVT100EncodedString .
Show-Markdown
a également la possibilité d’ouvrir un navigateur et de vous afficher une version rendue du 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 le rendu Show-Markdown
de 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 passez pas un format pris en charge, Show-Markdown
émet une erreur.
Type: | PSObject |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-LiteralPath
Spécifie le chemin d’accès à un fichier Markdown. Contrairement au paramètre Path, la valeur du paramètre LiteralPath est utilisée exactement telle que vous la tapez. 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 des séquences d’échappement.
Type: | String[] |
Aliases: | PSPath, LP |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Path
Spécifie le chemin d’accès à un fichier Markdown à afficher.
Type: | String[] |
Position: | 0 |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | True |
-UseBrowser
Compile l’entrée Markdown au format HTML et l’ouvre dans votre navigateur par défaut.
Type: | SwitchParameter |
Position: | Named |
Default value: | False |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
Entrées
String[]