Partager via

Export-MarkdownModuleFile

Module:
Microsoft.PowerShell.PlatyPS Module

Exporte un objet ModuleFileInfo vers un fichier markdown.

Syntaxe

__AllParameterSets 

Export-MarkdownModuleFile
    [-ModuleFileInfo] <ModuleFileInfo[]>
    [-Encoding <Encoding>]
    [-Force]
    [-Metadata <hashtable>]
    [-OutputFolder <string>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

Cette commande exporte un objet ModuleFileInfo 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 ModuleFileInfo à l’aide de l’applet de commande Import-MarkdownModuleFile. Vous pouvez importer un fichier de module écrit dans l’ancien format et l’exporter vers le nouveau format.

Exemples

Exemple 1 : convertir un ancien fichier de module au nouveau format

Dans cet exemple, un objet ModuleFileInfo en important un fichier Markdown de module à partir du dossier .\v1. Cet objet est ensuite exporté vers un fichier Markdown au nouveau format à l’aide de la Export-MarkdownModuleFile.

Import-MarkdownModuleFile -Path .\v1\Microsoft.PowerShell.PlatyPS\Microsoft.PowerShell.PlatyPS.md |
    Export-MarkdownModuleFile -OutputFolder .\v1\new\Microsoft.PowerShell.PlatyPS -Force

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

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---           8/26/2024  3:38 PM           2716 Microsoft.PowerShell.PlatyPS.md

Paramètres

-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

-ModuleFileInfo

Objet ModuleFileInfo à exporter vers un fichier markdown. Cet objet est créé par l’applet de commande Import-MarkdownModuleFile.

Propriétés du paramètre

Type:

Microsoft.PowerShell.PlatyPS.ModuleFileInfo[]

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

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

Sorties

FileInfo