New-YamlHelp

Riferimento

Modulo:: platyPS

Converte la Guida markdown in YAML in modo che venga letto facilmente da strumenti esterni

Sintassi

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

Descrizione

Il New-YamlHelp cmdlet funziona in modo analogo al New-ExternalHelp cmdlet, ma invece di creare un file MAML per supportare Get-Help, crea un set di file YAML che possono essere letti da strumenti esterni per fornire il rendering personalizzato delle pagine della Guida.

Esempio

Esempio 1: Creare file 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

Verrà creato un file YAML per ogni cmdlet in modo che gli strumenti esterni possano leggere i dati strutturati per ogni cmdlet.

Esempio 2: Creare file YAML con codifica specifica

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

Verranno letti e scritti i file nella codifica specificata. Il parametro Force sovrascriverà i file già esistenti.

Parametri

-Encoding

Specifica la codifica dei caratteri per il file della Guida esterna. Specificare un oggetto System.Text.Encoding . Per altre informazioni, vedere about_Character_Encoding.

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

-Force

Indica che questo cmdlet sovrascrive un file esistente con lo stesso nome.

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

-OutputFolder

Specifica la cartella in cui creare i file YAML

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

-Path

Specifica una matrice di percorsi di file o cartelle markdown. Questo cmdlet crea una Guida esterna basata su questi file e cartelle.

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

Input

String[]

È possibile inviare tramite pipe una matrice di percorsi a questo cmdlet.

Output

FileInfo[]

Questo cmdlet restituisce un FileInfo[] oggetto per i file creati.

Condividi tramite