Get-MarkdownMetadata
Obtient les métadonnées de l’en-tête d’un fichier Markdown.
Syntaxe
FromPath (Par défaut)
Get-MarkdownMetadata
-Path <String[]>
[<CommonParameters>]
FromMarkdownString
Get-MarkdownMetadata
-Markdown <String>
[<CommonParameters>]
Description
L’applet de commande Get-MarkdownMetadata obtient les métadonnées 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 à utiliser 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 à partir 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 variable $Markdown.
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 dossier .\docs.
Paramètres
-Markdown
Spécifie une chaîne qui contient du texte au format markdown.
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 |
Jeux de paramètres
FromMarkdownString
| 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 tableau de chemins d’accès de fichiers ou de dossiers Markdown.
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
FromPath
| Position: | Named |
| Obligatoire: | True |
| Valeur du pipeline: | True |
| Valeur du pipeline par nom de propriété: | True |
| 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.
Entrées
String
Vous pouvez diriger un tableau de chemins vers cette applet de commande.
Sorties
Dictionary
L’applet de commande retourne un objet Dictionary[String, String]. Le dictionnaire contient des paires clé-valeur trouvées dans le bloc de métadonnées Markdown.
