Export-YamlCommandHelp
將 CommandHelp 物件匯出至 YAML 檔案。
語法
__AllParameterSets
Export-YamlCommandHelp
[-CommandHelp] <CommandHelp[]>
[-Encoding <Encoding>]
[-Force]
[-OutputFolder <string>]
[-Metadata <hashtable>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
Description
此命令會將 CommandHelp 物件匯出至 Yaml 檔案。 您可以使用 Metadata 參數，將元數據前端新增至 Yaml 檔案。 您可以使用 Cmdlet 或其中一個 Export-YamlCommandHelp Cmdlet 來取得 Import-* 物件。
範例
範例 1 - 將 Markdown 命令說明內容轉換為 Yaml 格式
本範例會從 .\v1 資料夾匯入舊格式的 Markdown 說明，並以新格式將它匯出至 .\v2 資料夾。
$mdfiles = Measure-PlatyPSMarkdown -Path .\v2\Microsoft.PowerShell.PlatyPS\*.md
$mdfiles | Where-Object Filetype -match 'CommandHelp' |
Import-MarkdownCommandHelp -Path {$_.FilePath} |
Export-YamlCommandHelp -OutputFolder .\v2\yaml
Directory: D:\Git\PS-Src\platyPS\v2docs\v2\yaml
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a--- 8/26/2024 3:56 PM 3535 Compare-CommandHelp.yml
-a--- 8/26/2024 3:56 PM 4776 Export-MamlCommandHelp.yml
-a--- 8/26/2024 3:56 PM 8150 Export-MarkdownCommandHelp.yml
-a--- 8/26/2024 3:56 PM 4998 Export-MarkdownModuleFile.yml
-a--- 8/26/2024 3:56 PM 6357 Export-YamlCommandHelp.yml
-a--- 8/26/2024 3:56 PM 5396 Export-YamlModuleFile.yml
-a--- 8/26/2024 3:56 PM 3019 Import-MamlHelp.yml
-a--- 8/26/2024 3:56 PM 4235 Import-MarkdownCommandHelp.yml
-a--- 8/26/2024 3:56 PM 4318 Import-MarkdownModuleFile.yml
-a--- 8/26/2024 3:56 PM 4391 Import-YamlCommandHelp.yml
-a--- 8/26/2024 3:56 PM 3862 Import-YamlModuleFile.yml
-a--- 8/26/2024 3:56 PM 2325 Measure-PlatyPSMarkdown.yml
-a--- 8/26/2024 3:56 PM 5190 New-CommandHelp.yml
-a--- 8/26/2024 3:56 PM 8335 New-MarkdownCommandHelp.yml
-a--- 8/26/2024 3:56 PM 4697 New-MarkdownModuleFile.yml
-a--- 8/26/2024 3:56 PM 3468 Test-MarkdownCommandHelp.yml
-a--- 8/26/2024 3:56 PM 3172 Update-CommandHelp.yml
-a--- 8/26/2024 3:56 PM 3908 Update-MarkdownCommandHelp.yml
-a--- 8/26/2024 3:56 PM 5217 Update-MarkdownModuleFile.yml
參數
-CommandHelp
要匯出 CommandHelp 物件。 您可以傳遞管線上的 CommandHelp 物件，或使用 Command 參數。
參數屬性
| 類型: | Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | 0 |
| 必要: | True |
| 來自管線的值: | True |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Confirm
在執行 Cmdlet 之前，提示您進行確認。
參數屬性
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Encoding
寫入 Markdown 檔案時要使用的編碼方式。 如果未指定任何值，編碼會預設為 $OutputEncoding 喜好設定變數的值。
參數屬性
| 類型: | Encoding
|
| 預設值: | False |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-Force
使用 Force 參數，在輸出檔案已經存在時覆寫輸出檔案。
參數屬性
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
要新增至 Markdown 檔案前端的元數據。 元數據是哈希表，您可以在其中指定要新增至frontmatter的索引鍵和值組。 新的索引鍵名稱會新增至現有的前端。 會覆寫現有索引鍵的值。
| 類型: | Hashtable
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-OutputFolder
儲存 Markdown 檔案的資料夾。 如果資料夾不存在，則會建立該資料夾。
參數屬性
| 類型: | String
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
-WhatIf
在僅報告將發生的情況而不執行作的模式下運行命令。
參數屬性
參數集
(All)
| Position: | Named |
| 必要: | False |
| 來自管線的值: | False |
| 來自管線按屬性名稱的值: | False |
| 來自剩餘引數的值: | False |
CommonParameters
此 Cmdlet 支援一般參數：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊，請參閱 about_CommonParameters。
Microsoft.PowerShell.PlatyPS.Model.CommandHelp
輸出