New-YamlHelp

Referenz

Modul:: platyPS

Konvertiert Markdownhilfe in YAML, damit sie von externen Tools leicht gelesen werden kann

Syntax

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

Beschreibung

Das New-YamlHelp Cmdlet funktioniert ähnlich wie das New-ExternalHelp Cmdlet, erstellt jedoch nicht eine MAML-Datei zur Unterstützung Get-Help, sondern erstellt einen Satz von YAML-Dateien, die von externen Tools gelesen werden können, um ein benutzerdefiniertes Rendering von Hilfeseiten bereitzustellen.

Beispiele

Beispiel 1: Erstellen von YAML-Dateien

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

Dadurch wird eine YAML-Datei für jedes Cmdlet erstellt, damit externe Tools die strukturierten Daten für jedes Cmdlet lesen können.

Beispiel 2: Erstellen von YAML-Dateien mit einer bestimmten Codierung

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

Dadurch werden die Dateien in der angegebenen -Codierung sowohl gelesen als auch geschrieben. Der Force-Parameter überschreibt bereits vorhandene Dateien.

Parameter

-Encoding

Gibt die Zeichencodierung für Ihre externe Hilfedatei an. Geben Sie ein System.Text.Encoding-Objekt an. Weitere Informationen finden Sie unter about_Character_Encoding.

Type:	Encoding
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-Force

Gibt an, dass dieses Cmdlet eine vorhandene Datei mit demselben Namen überschreibt.

Type:	SwitchParameter
Position:	Named
Default value:	None
Required:	False
Accept pipeline input:	False
Accept wildcard characters:	False

-OutputFolder

Gibt den Ordner an, in dem die YAML-Dateien erstellt werden sollen.

Type:	String
Position:	Named
Default value:	None
Required:	True
Accept pipeline input:	False
Accept wildcard characters:	False

-Path

Gibt ein Array von Pfaden von Markdowndateien oder -ordnern an. Dieses Cmdlet erstellt externe Hilfe basierend auf diesen Dateien und Ordnern.

Type:	String[]
Position:	1
Default value:	None
Required:	True
Accept pipeline input:	True
Accept wildcard characters:	False

Eingaben

String[]

Sie können ein Array von Pfaden an dieses Cmdlet weiterleiten.

Ausgaben

FileInfo[]

Dieses Cmdlet gibt ein FileInfo[] Objekt für erstellte Dateien zurück.

Freigeben über