Update-MarkdownModuleFile

Module:

Microsoft.PowerShell.PlatyPS Module

Met à jour le fichier de module Markdown.

Syntaxe

path

Update-MarkdownModuleFile
    [-Path] <string>
    [-CommandHelp] <CommandHelp[]>
    [-Encoding <Encoding>]
    [-Force]
    [-HelpInfoUri <string>]
    [-HelpVersion <version>]
    [-Locale <string>]
    [-Metadata <hashtable>]
    [-NoBackup]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

literalpath

Update-MarkdownModuleFile
    [-CommandHelp] <CommandHelp[]>
    -LiteralPath <string>
    [-Encoding <Encoding>]
    [-Force]
    [-HelpInfoUri <string>]
    [-HelpVersion <version>]
    [-Locale <string>]
    [-Metadata <hashtable>]
    [-NoBackup]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Cette applet de commande met à jour un fichier de module Markdown avec CommandHelp informations sur l’objet importées à partir des fichiers de commande Markdown.

Exemples

Exemple 1 - Mettre à jour un fichier de module à partir de nouveaux fichiers d’aide de commande

$mdfiles = Measure-PlatyPSMarkdown -Path .\Microsoft.PowerShell.PlatyPS\*.md
$mdfiles | Where-Object Filetype -match 'CommandHelp' |
    Import-MarkdownCommandHelp -Path {$_.FilePath} |
    Update-MarkdownModuleFile -Path .\Microsoft.PowerShell.PlatyPS\Microsoft.PowerShell.PlatyPS.md

Paramètres

-CommandHelp

Objets CommandHelp à exporter. Vous pouvez transmettre l’objet CommandHelp sur le pipeline ou à l’aide de ce paramètre.

Propriétés du paramètre

Type:	Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]
Valeur par défaut:	None
Prend en charge les caractères génériques:	False
DontShow:	False

Jeux de paramètres

(All)

Position:	1
Obligatoire:	True
Valeur du pipeline:	True
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-Confirm

Vous invite à confirmer avant d’exécuter l’applet de commande.

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
Alias:	cf

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

-Encoding

Encodage à utiliser lors de l’écriture du fichier markdown. Si aucune valeur n’est spécifiée, l’encodage est défini par défaut sur la valeur de la variable de préférence $OutputEncoding.

Propriétés du paramètre

Type:	Encoding
Valeur par défaut:	None
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

-Force

Utilisez le paramètre Forcer pour remplacer le fichier de sortie s’il existe déjà.

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

-HelpInfoUri

Ce paramètre vous permet de spécifier l’URI utilisé pour l’aide pouvant être mise à jour. Par défaut, l’applet de commande utilise HelpInfoUri spécifiée dans le manifeste du module.

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

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-HelpVersion

Ce paramètre vous permet de spécifier la version de l’aide. La valeur par défaut est 1.0.0.0. Cette version est écrite dans le fichier HelpInfo.xml utilisé pour obtenir de l’aide pouvant être mise à jour.

Propriétés du paramètre

Type:	Version
Valeur par défaut:	None
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

-LiteralPath

Spécifie un chemin d’accès à un ou plusieurs fichiers markdown de module. 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.

Pour plus d'informations, consultez la section sur les règles de citation.

Propriétés du paramètre

Type:	String
Valeur par défaut:	False
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é:	False
Valeur des arguments restants:	False

-Locale

Ce paramètre vous permet de spécifier les paramètres régionaux de langue pour les fichiers d’aide. Par défaut, l’applet de commande utilise leCultureInfo actuel. Utilisez l’applet de commande Get-Culture pour afficher les paramètres de culture actuels sur votre système.

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

(All)

Position:	Named
Obligatoire:	False
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-Metadata

Métadonnées à ajouter au frontmatter du fichier markdown. Les métadonnées sont une table de hachage où vous spécifiez les paires clé et valeur à ajouter au frontmatter. Les nouveaux noms de clés sont ajoutés au frontmatter existant. Les valeurs des clés existantes sont remplacées. Vous ne pouvez pas remplacer les valeurs des clés document type ou PlatyPS schema version. Si ces clés sont présentes dans la table de hachage, l’applet de commande ignore les valeurs et génère un avertissement.

Propriétés du paramètre

Type:	Hashtable
Valeur par défaut:	None
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

-NoBackup

Par défaut, l’applet de commande crée une sauvegarde du fichier Markdown d’origine avant de la mettre à jour. Utilisez ce paramètre pour supprimer la création du fichier de sauvegarde.

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

-Path

Spécifie un chemin d’accès à un ou plusieurs fichiers markdown de module.

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

path

Position:	0
Obligatoire:	True
Valeur du pipeline:	False
Valeur du pipeline par nom de propriété:	False
Valeur des arguments restants:	False

-WhatIf

Exécute la commande dans un mode qui signale uniquement ce qui se passerait sans effectuer les actions.

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
Alias:	Wi

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.

Entrées

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

Sorties

FileInfo

Liens associés

• New-MarkdownModuleFile