New-YamlHelp

模組:

platyPS

將 Markdown 說明轉換成 YAML，以便由外部工具輕鬆閱讀

Syntax

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

Description

此 New-YamlHelp Cmdlet 的運作方式 New-ExternalHelp 類似于 Cmdlet，而不是建立 MAML 檔案以支援 Get-Help ，它會建立一組 YAML 檔案，供外部工具讀取，以提供自訂說明頁面的轉譯。

範例

範例 1：建立 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

這會為每個 Cmdlet 建立一個 YAML 檔案，讓外部工具可以讀取每個 Cmdlet 的結構化資料。

範例 2：建立具有特定編碼方式的 YAML 檔案

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

這會讀取和寫入指定之 -Encoding 中的檔案。 Force參數會覆寫已經存在的檔案。

參數

-Encoding

指定外部說明檔的字元編碼。 指定 System.Text.Encoding 物件。 如需詳細資訊，請參閱 about_Character_Encoding。

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

-Force

表示此 Cmdlet 會覆寫具有相同名稱的現有檔案。

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

-OutputFolder

指定要在 中建立 YAML 檔案的資料夾

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

-Path

指定 Markdown 檔案或資料夾的路徑陣列。 此 Cmdlet 會根據這些檔案和資料夾建立外部說明。

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

輸入

String[]

您可以使用管線將路徑陣列傳送至此 Cmdlet。

輸出

FileInfo[]

此 Cmdlet 會 FileInfo[] 傳回已建立檔案的 物件。