Export-MarkdownCommandHelp

Module:

Microsoft.PowerShell.PlatyPS Module

Exporte un objet CommandHelp vers un fichier markdown.

Syntaxe

__AllParameterSets

Export-MarkdownCommandHelp
    [-CommandHelp] <CommandHelp[]>
    [-Encoding <Encoding>]
    [-Force]
    [-OutputFolder <string>]
    [-Metadata <hashtable>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Cette commande exporte un objet CommandHelp vers un fichier Markdown. Vous pouvez ajouter un frontmatter de métadonnées au fichier Markdown à l’aide du paramètre Metadata. Vous pouvez obtenir un objet CommandHelp à l’aide de l’applet de commande Export-MarkdownCommandHelp ou de l’une des applets de commande Import-*.

Exemples

Exemple 1 - Convertir l’ancien contenu d’aide Markdown au nouveau format

Cet exemple importe l’aide Markdown dans l’ancien format du dossier .\v1 et l’exporte vers le dossier .\v2 dans le nouveau format.

$chobj = Import-MarkdownCommandHelp -Path .\v1\Export-YamlModuleFile.md
Export-MarkdownCommandHelp -CommandHelp $chobj -OutputFolder .\v2

    Directory: D:\Git\PS-Src\platyPS\v2docs\v2

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---           5/20/2024  3:33 PM           2892 Export-YamlModuleFile.md

Exemple 2 : Convertir un dossier de l’ancien contenu d’aide Markdown au nouveau format

Cet exemple importe l’aide Markdown dans l’ancien format du dossier .\v1 et l’exporte vers le dossier .\v1\new dans le nouveau format. Si nécessaire, Export-MarkdownCommandHelp crée les dossiers de destination. Les nouveaux fichiers markdown sont écrits dans le dossier nommé pour le module auquel ils appartiennent.

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

    Directory: D:\Git\PS-Src\platyPS\v2docs\v1\new\Microsoft.PowerShell.PlatyPS

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---           8/26/2024  3:30 PM           3194 Compare-CommandHelp.md
-a---           8/26/2024  3:30 PM           4282 Export-MamlCommandHelp.md
-a---           8/26/2024  3:30 PM           6401 Export-MarkdownCommandHelp.md
-a---           8/26/2024  3:30 PM           4874 Export-MarkdownModuleFile.md
-a---           8/26/2024  3:30 PM           6429 Export-YamlCommandHelp.md
-a---           8/26/2024  3:30 PM           5601 Export-YamlModuleFile.md
-a---           8/26/2024  3:30 PM           2724 Import-MamlHelp.md
-a---           8/26/2024  3:30 PM           3733 Import-MarkdownCommandHelp.md
-a---           8/26/2024  3:30 PM           3870 Import-MarkdownModuleFile.md
-a---           8/26/2024  3:30 PM           3907 Import-YamlCommandHelp.md
-a---           8/26/2024  3:30 PM           3477 Import-YamlModuleFile.md
-a---           8/26/2024  3:30 PM           2088 Measure-PlatyPSMarkdown.md
-a---           8/26/2024  3:30 PM           4748 New-CommandHelp.md
-a---           8/26/2024  3:30 PM           8647 New-MarkdownCommandHelp.md
-a---           8/26/2024  3:30 PM           5086 New-MarkdownModuleFile.md
-a---           8/26/2024  3:30 PM           3080 Test-MarkdownCommandHelp.md
-a---           8/26/2024  3:30 PM           3041 Update-CommandHelp.md
-a---           8/26/2024  3:30 PM           3981 Update-MarkdownCommandHelp.md
-a---           8/26/2024  3:30 PM           5548 Update-MarkdownModuleFile.md

Paramètres

-CommandHelp

Objet CommandHelp à exporter. Vous pouvez transmettre l’objet CommandHelp sur le pipeline ou à l’aide du paramètre command .

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:	0
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:	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

-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

-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.

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

-OutputFolder

Dossier dans lequel le fichier markdown est enregistré. Si le dossier n’existe pas, il est créé.

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

-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

• Export-YamlCommandHelp
• Import-MarkdownCommandHelp
• Import-YamlCommandHelp