Partager via

New-YamlHelp

Module:
platyPS Module

Convertit l’aide Markdown en YAML pour être lue facilement par des outils externes

Syntaxe

Default (Par défaut) 

New-YamlHelp
    [-Path] <String[]>
    -OutputFolder <String>
    [-Encoding <Encoding>]
    [-Force]
    [<CommonParameters>]

Description

L’applet de commande New-YamlHelp fonctionne de la même façon que l’applet de commande New-ExternalHelp, mais plutôt que de créer un fichier MAML pour prendre en charge Get-Help, il crée un ensemble de fichiers YAML qui peuvent être lus par des outils externes pour fournir un rendu personnalisé des pages d’aide.

Exemples

Exemple 1 : Créer des fichiers YAML

PS C:\> New-YamlHelp -Path .\docs -OutputFolder .\out\yaml

    Directory: D:\Working\PlatyPS\out\yaml


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        6/15/2017  11:13 AM           2337 Get-HelpPreview.yml
-a----        6/15/2017  11:13 AM           3502 Get-MarkdownMetadata.yml
-a----        6/15/2017  11:13 AM           4143 New-ExternalHelp.yml
-a----        6/15/2017  11:13 AM           3082 New-ExternalHelpCab.yml
-a----        6/15/2017  11:13 AM           2581 New-MarkdownAboutHelp.yml
-a----        6/15/2017  11:13 AM          12356 New-MarkdownHelp.yml
-a----        6/15/2017  11:13 AM           1681 New-YamlHelp.yml
-a----        6/15/2017  11:13 AM           5053 Update-MarkdownHelp.yml
-a----        6/15/2017  11:13 AM           4661 Update-MarkdownHelpModule.yml
-a----        6/15/2017  11:13 AM           3350 Update-MarkdownHelpSchema.yml

Cela crée un fichier YAML pour chaque applet de commande afin que les outils externes puissent lire les données structurées pour chaque applet de commande.

Exemple 2 : Créer des fichiers YAML avec un encodage spécifique

PS C:\> New-YamlHelp -Path .\docs -OutputFolder .\out\yaml -Force -Encoding ([System.Text.Encoding]::Unicode)

    Directory: D:\Working\PlatyPS\out\yaml


Mode                LastWriteTime         Length Name
----                -------------         ------ ----
-a----        6/15/2017  11:13 AM           2337 Get-HelpPreview.yml
-a----        6/15/2017  11:13 AM           3502 Get-MarkdownMetadata.yml
-a----        6/15/2017  11:13 AM           4143 New-ExternalHelp.yml
-a----        6/15/2017  11:13 AM           3082 New-ExternalHelpCab.yml
-a----        6/15/2017  11:13 AM           2581 New-MarkdownAboutHelp.yml
-a----        6/15/2017  11:13 AM          12356 New-MarkdownHelp.yml
-a----        6/15/2017  11:13 AM           1681 New-YamlHelp.yml
-a----        6/15/2017  11:13 AM           5053 Update-MarkdownHelp.yml
-a----        6/15/2017  11:13 AM           4661 Update-MarkdownHelpModule.yml
-a----        6/15/2017  11:13 AM           3350 Update-MarkdownHelpSchema.yml

Cela lit et écrit les fichiers dans l’encodage spécifié. Le paramètre Forcer remplacera les fichiers qui existent déjà.

Paramètres

-Encoding

Spécifie l’encodage de caractères pour votre fichier d’aide externe. Spécifiez un objet System.Text.Encoding. Pour plus d’informations, consultez about_Character_Encoding.

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

Indique que cette applet de commande remplace un fichier existant portant le même nom.

Propriétés du paramètre

Type:SwitchParameter
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

Spécifie le dossier dans lequel créer les fichiers YAML dans

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: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. Cette applet de commande crée une aide externe basée sur ces fichiers et dossiers.

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

FileInfo

Cette applet de commande retourne un objet FileInfo[] pour les fichiers créés.