Export-MarkdownCommandHelp
将 CommandHelp 对象导出到 markdown 文件。
语法
__AllParameterSets
Export-MarkdownCommandHelp
[-CommandHelp] <CommandHelp[]>
[-Encoding <Encoding>]
[-Force]
[-OutputFolder <string>]
[-Metadata <hashtable>]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
说明
此命令将 CommandHelp 对象导出到 markdown 文件。 可以使用 Metadata 参数将元数据 frontmatter 添加到 markdown 文件。 可以使用 cmdlet 或 Export-MarkdownCommandHelp cmdlet 之一来获取 Import-* 对象。
示例
示例 1 - 将旧的 Markdown 帮助内容转换为新格式
此示例从 .\v1 文件夹中导入旧格式的 Markdown 帮助，并将其导出到新格式的 .\v2 文件夹中。
$chobj = Import-MarkdownCommandHelp -Path .\v1\Export-YamlModuleFile.md
Export-MarkdownCommandHelp -CommandHelp $chobj -OutputFolder .\v2
Directory: D:\Git\PS-Src\platyPS\v2docs\v2
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a--- 5/20/2024 3:33 PM 2892 Export-YamlModuleFile.md
示例 2 - 将旧 Markdown 帮助内容的文件夹转换为新格式
此示例从 .\v1 文件夹中导入旧格式的 Markdown 帮助，并将其导出到新格式的 .\v1\new 文件夹中。 如有必要，Export-MarkdownCommandHelp 创建目标文件夹。 新的 markdown 文件将写入为其所属模块命名的文件夹。
$mdfiles = Measure-PlatyPSMarkdown -Path .\v1\Microsoft.PowerShell.PlatyPS\*.md
$mdfiles | Where-Object Filetype -match 'CommandHelp' |
Import-MarkdownCommandHelp -Path {$_.FilePath} |
Export-MarkdownCommandHelp -OutputFolder .\v1\new
Directory: D:\Git\PS-Src\platyPS\v2docs\v1\new\Microsoft.PowerShell.PlatyPS
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a--- 8/26/2024 3:30 PM 3194 Compare-CommandHelp.md
-a--- 8/26/2024 3:30 PM 4282 Export-MamlCommandHelp.md
-a--- 8/26/2024 3:30 PM 6401 Export-MarkdownCommandHelp.md
-a--- 8/26/2024 3:30 PM 4874 Export-MarkdownModuleFile.md
-a--- 8/26/2024 3:30 PM 6429 Export-YamlCommandHelp.md
-a--- 8/26/2024 3:30 PM 5601 Export-YamlModuleFile.md
-a--- 8/26/2024 3:30 PM 2724 Import-MamlHelp.md
-a--- 8/26/2024 3:30 PM 3733 Import-MarkdownCommandHelp.md
-a--- 8/26/2024 3:30 PM 3870 Import-MarkdownModuleFile.md
-a--- 8/26/2024 3:30 PM 3907 Import-YamlCommandHelp.md
-a--- 8/26/2024 3:30 PM 3477 Import-YamlModuleFile.md
-a--- 8/26/2024 3:30 PM 2088 Measure-PlatyPSMarkdown.md
-a--- 8/26/2024 3:30 PM 4748 New-CommandHelp.md
-a--- 8/26/2024 3:30 PM 8647 New-MarkdownCommandHelp.md
-a--- 8/26/2024 3:30 PM 5086 New-MarkdownModuleFile.md
-a--- 8/26/2024 3:30 PM 3080 Test-MarkdownCommandHelp.md
-a--- 8/26/2024 3:30 PM 3041 Update-CommandHelp.md
-a--- 8/26/2024 3:30 PM 3981 Update-MarkdownCommandHelp.md
-a--- 8/26/2024 3:30 PM 5548 Update-MarkdownModuleFile.md
参数
-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
输出