New-MarkdownCommandHelp
为 PowerShell 模块和命令创建 Markdown 帮助文件。
语法
__AllParameterSets
New-MarkdownCommandHelp
-OutputFolder <string>
[-CommandInfo <CommandInfo[]>]
[-Encoding <Encoding>]
[-Force]
[-HelpUri <string>]
[-HelpInfoUri <string>]
[-HelpVersion <version>]
[-Locale <string>]
[-Metadata <hashtable>]
[-ModuleInfo <psmoduleinfo[]>]
[-WithModulePage]
[-AbbreviateParameterTypename]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
说明
为 PowerShell 模块和命令创建 Markdown 帮助文件。
示例
示例 1 - 为模块创建 Markdown 帮助文件
$newMarkdownCommandHelpSplat = @{
ModuleInfo = Get-Module Microsoft.PowerShell.PlatyPS
OutputFolder = '.'
HelpVersion = '1.0.0.0'
WithModulePage = $true
}
New-MarkdownCommandHelp @newMarkdownCommandHelpSplat
示例 2 - 从命令列表中创建 Markdown 帮助文件
$newMarkdownCommandHelpSplat = @{
CommandInfo = Get-Command -Module Microsoft.PowerShell.PlatyPS
OutputFolder = '.'
HelpVersion = '1.0.0.0'
WithModulePage = $true
}
New-MarkdownCommandHelp @newMarkdownCommandHelpSplat
参数
-AbbreviateParameterTypename
默认情况下，此命令在参数元数据和输入和输出类型中使用全类型名称。 使用此参数时，cmdlet 输出短类型名称。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-CommandInfo
要为其创建帮助的一个或多个命令的列表。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | True |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Confirm
在运行 cmdlet 之前，提示你进行确认。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Encoding
创建输出文件时使用的编码。 如果未指定，则 cmdlet 使用由 $OutputEncoding指定的值。
参数属性
| 类型: | Encoding
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Force
默认情况下，此命令不会覆盖现有文件。 使用此参数时，cmdlet 将覆盖现有文件。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-HelpInfoUri
此参数允许指定用于可更新帮助的 URI。 默认情况下，cmdlet 使用模块清单中指定的 HelpInfoUri。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-HelpUri
此参数允许指定用于联机帮助的 URI。 默认情况下，该 cmdlet 使用命令的 [CmdletBinding()] 属性中定义的 URI。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-HelpVersion
此参数允许指定帮助的版本。 默认值是 1.0.0.0。 此版本将写入用于可更新帮助的 HelpInfo.xml 文件。
参数属性
| 类型: | Version
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-Locale
此参数允许指定帮助文件的语言区域设置。 默认情况下，cmdlet 使用当前 CultureInfo。 使用 Get-Culture cmdlet 查看系统上的当前区域性设置。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
要添加到 markdown 文件的 frontmatter 的元数据。 元数据是一个哈希表，可在其中指定要添加到 frontmatter 的键和值对。 新键名称将添加到现有 frontmatter。 覆盖现有键的值。 不能覆盖 document type 或 PlatyPS schema version 键的值。 如果这些键存在于哈希表中，则 cmdlet 将忽略这些值并输出警告。
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-ModuleInfo
要为其创建帮助的一个或多个模块的列表。 该 cmdlet 为模块中的所有命令创建 Markdown 帮助文件。 该 cmdlet 在输出位置创建一个与模块名称匹配的文件夹。 所有 Markdown 文件都写入模块文件夹。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | True |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-OutputFolder
指定 Markdown 帮助文件写入位置。 该 cmdlet 为正在处理的每个模块创建一个文件夹。 如果目标命令未与模块关联，则 cmdlet 会在输出文件夹的根目录中创建 Markdown 文件。
参数属性
| 类型: | String
|
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
参数集
(All)
| Position: | Named |
| 必需: | True |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-WhatIf
在仅报告将发生的情况而不执行作的模式下运行命令。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
-WithModulePage
默认情况下，此 cmdlet 仅为命令创建 Markdown 文件。 使用此参数时，cmdlet 将为模块创建 Markdown 文件。 此 Markdown 文件包含用于创建 HelpInfo.xml 文件的模块和元数据中的所有命令的列表。
参数属性
参数集
(All)
| Position: | Named |
| 必需: | False |
| 来自管道的值: | False |
| 来自管道的值（按属性名称）: | False |
| 来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。
输出