Partager via

Show-Markdown

  • Référence
Module:
Microsoft.PowerShell.Utility

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

Show-Markdown
    [-Path] <String[]>
    [-UseBrowser]
    [<CommonParameters>]
Show-Markdown
    -InputObject <PSObject>
    [-UseBrowser]
    [<CommonParameters>]
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.

Type:PSObject
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques: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é comme des caractères génériques. Si le chemin inclut des caractères d’échappement, placez-le entre guillemets simples. Les guillemets simples indiquent à PowerShell de ne pas interpréter de caractères comme séquences d’échappement.

Type:String[]
Alias:PSPath, LP
Position:Named
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:False

-Path

Spécifie le chemin d’accès à un fichier Markdown à afficher.

Type:String[]
Position:0
Valeur par défaut:None
Obligatoire:True
Accepter l'entrée de pipeline:True
Accepter les caractères génériques:True

-UseBrowser

Compile l’entrée Markdown en tant que code HTML et l’ouvre dans votre navigateur par défaut.

Type:SwitchParameter
Position:Named
Valeur par défaut:False
Obligatoire:False
Accepter l'entrée de pipeline:False
Accepter les caractères génériques:False

Entrées

PSObject

String[]

Sorties

String