Get-MarkdownMetadata

Référence

Module:: platyPS

Obtient les métadonnées de l’en-tête d’un fichier markdown.

Syntax

Get-MarkdownMetadata
   -Path <String[]>
   [<CommonParameters>]

Get-MarkdownMetadata
   -Markdown <String>
   [<CommonParameters>]

Description

L’applet Get-MarkdownMetadata de commande obtient les métadonnées à partir de l’en-tête d’un fichier markdown pris en charge par PlatyPS. La commande retourne les métadonnées sous forme de table de hachage.

PlatyPS stocke les métadonnées dans le bloc d’en-tête d’un fichier markdown sous forme de paires clé-valeur de chaînes. Par défaut, PlatyPS stocke le nom du fichier d’aide et la version du schéma markdown.

La section Métadonnées peut contenir des valeurs fournies par l’utilisateur pour une utilisation avec des outils externes. L’applet de commande New-ExternalHelp ignore ces métadonnées.

Exemples

Exemple 1 : Obtenir des métadonnées à partir d’un fichier

PS C:\> Get-MarkdownMetadata -Path ".\docs\Get-MarkdownMetadata.md"

Key                Value
---                -----
external help file platyPS-help.xml
schema             2.0.0

Cette commande récupère les métadonnées d’un fichier markdown.

Exemple 2 : Obtenir des métadonnées à partir d’une chaîne markdown

PS C:\> $Markdown = Get-Content -Path ".\docs\Get-MarkdownMetadata.md" -Raw
PS C:\> Get-MarkdownMetadata -Markdown $Markdown

Key                Value
---                -----
external help file platyPS-help.xml
schema             2.0.0

La première commande obtient le contenu d’un fichier et les stocke dans la $Markdown variable.

La deuxième commande récupère les métadonnées de la chaîne dans $Metadata.

Exemple 3 : Obtenir des métadonnées à partir de tous les fichiers d’un dossier

PS C:\> Get-MarkdownMetadata -Path ".\docs"

Key                Value
---                -----
external help file platyPS-help.xml
schema             2.0.0
external help file platyPS-help.xml
schema             2.0.0
external help file platyPS-help.xml
schema             2.0.0
external help file platyPS-help.xml
schema             2.0.0
external help file platyPS-help.xml
schema             2.0.0
external help file platyPS-help.xml
schema             2.0.0
external help file platyPS-help.xml
schema             2.0.0
external help file platyPS-help.xml
schema             2.0.0

Cette commande obtient les métadonnées de chacun des fichiers markdown dans le .\docs dossier.

Paramètres

-Markdown

Spécifie une chaîne qui contient du texte au format markdown.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Path

Spécifie un tableau de chemins d’accès de fichiers ou dossiers markdown.

Type:	String[]
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	True

Entrées

String[]

Vous pouvez diriger un tableau de chemins vers cette applet de commande.

Sorties

Dictionary[String, String]

L’applet de commande retourne un Dictionary[String, String] objet. Le dictionnaire contient des paires clé-valeur trouvées dans le bloc de métadonnées markdown.

Partager via