Export-YamlCommandHelp
将 CommandHelp 对象导出到 YAML 文件。
语法
__AllParameterSets
Export-YamlCommandHelp
[-CommandHelp] <CommandHelp[]>
[-Encoding <Encoding>]
[-Force]
[-OutputFolder <string>]
[-Metadata <hashtable>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
说明
此命令将 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 的元数据。 元数据是一个哈希表，可在其中指定要添加到 frontmatter 的键和值对。 新键名称将添加到现有 frontmatter。 覆盖现有键的值。
(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
输出