New-MarkdownHelp
以 markdown 格式创建帮助。
语法
New-MarkdownHelp
-Module <String[]>
[-Session <PSSession>]
[-Force]
[-AlphabeticParamsOrder]
[-Metadata <Hashtable>]
-OutputFolder <String>
[-NoMetadata]
[-UseFullTypeName]
[-Encoding <Encoding>]
[-WithModulePage]
[-ModulePagePath <String>]
[-Locale <String>]
[-HelpVersion <String>]
[-FwLink <String>]
[-ExcludeDontShow]
[<CommonParameters>] New-MarkdownHelp
-Command <String[]>
[-Session <PSSession>]
[-Force]
[-AlphabeticParamsOrder]
[-Metadata <Hashtable>]
[-OnlineVersionUrl <String>]
-OutputFolder <String>
[-NoMetadata]
[-UseFullTypeName]
[-Encoding <Encoding>]
[-ExcludeDontShow]
[<CommonParameters>] New-MarkdownHelp
-MamlFile <String[]>
[-ConvertNotesToList]
[-ConvertDoubleDashLists]
[-Force]
[-AlphabeticParamsOrder]
[-Metadata <Hashtable>]
-OutputFolder <String>
[-NoMetadata]
[-UseFullTypeName]
[-Encoding <Encoding>]
[-WithModulePage]
[-ModulePagePath <String>]
[-Locale <String>]
[-HelpVersion <String>]
[-FwLink <String>]
[-ModuleName <String>]
[-ModuleGuid <String>]
[-ExcludeDontShow]
[<CommonParameters>] 说明
New-MarkdownHelp cmdlet 基于模块、命令或Microsoft帮助标记语言（MAML）格式的文件，以 markdown 格式创建帮助。
示例
示例 1：从命令创建帮助
PS C:\> function Command03 {param([string]$Value)}
PS C:\> New-MarkdownHelp -Command "Command03" -OutputFolder ".\docs"
Directory: D:\Working\docs
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 5/22/2016 6:53 PM 664 Command03.md第一个命令使用标准 Windows PowerShell 语法创建名为 Command03 的函数。
第二个命令为 .\docs 文件夹中的存根函数创建帮助。
示例 2：从模块创建帮助
PS C:\> Import-Module -Module "PlatyPS"
PS C:\> New-MarkdownHelp -Module "PlatyPS" -OutputFolder ".\docs" -Force
Directory: D:\Working\PlatyPS\docs
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 5/22/2016 6:54 PM 1496 Get-HelpPreview.md
-a---- 5/22/2016 6:54 PM 3208 Get-MarkdownMetadata.md
-a---- 5/22/2016 6:54 PM 3059 New-ExternalHelp.md
-a---- 5/22/2016 6:54 PM 2702 New-ExternalHelpCab.md
-a---- 5/22/2016 6:54 PM 6234 New-MarkdownHelp.md
-a---- 5/22/2016 6:54 PM 2346 Update-MarkdownHelp.md
-a---- 5/22/2016 6:54 PM 1633 Update-MarkdownHelpModule.md
-a---- 5/22/2016 6:54 PM 1630 Update-MarkdownHelpSchema.md第一个命令使用 cmdlet 将 Import-Module 模块加载到当前会话中。
第二个命令为 PlatyPS 模块中的所有 cmdlet 创建帮助。 它将它们存储在 .\docs 文件夹中。 此命令指定 Force 参数。 因此，它会覆盖具有相同名称的现有帮助 markdown 文件。
示例 3：从现有 MAML 文件创建帮助
PS C:\> New-MarkdownHelp -OutputFolder "D:\PSReadLine\docs" -MamlFile 'C:\Program Files\WindowsPowerShell\Modules\PSReadLine\1.1\en-US\Microsoft.PowerShell.PSReadLine.dll-help.xml'
Directory: D:\PSReadLine\docs
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 5/22/2016 6:56 PM 7443 Get-PSReadLineKeyHandler.md
-a---- 5/22/2016 6:56 PM 3586 Get-PSReadLineOption.md
-a---- 5/22/2016 6:56 PM 1549 Remove-PSReadLineKeyHandler.md
-a---- 5/22/2016 6:56 PM 5947 Set-PSReadLineKeyHandler.md
-a---- 5/22/2016 6:56 PM 15320 Set-PSReadLineOption.md此命令为指定的帮助 MAML 文件创建 markdown 格式的帮助。 无需加载模块，如前面的示例所示。 如果模块已加载，此命令将基于 MAML 文件（而不是当前安装的模块）创建帮助。
示例 4：从现有 MAML 文件创建帮助以在 CAB 文件中使用
PS C:\> New-MarkdownHelp -OutputFolder "D:\PSReadLine\docs" -MamlFile 'C:\Program Files\WindowsPowerShell\Modules\PSReadLine\1.1\en-US\Microsoft.PowerShell.PSReadLine.dll-help.xml' -WithModulePage -Force -ModuleName "PSReadLine"
Directory: D:\PSReadLine\docs
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a---- 5/22/2016 6:59 PM 7443 Get-PSReadLineKeyHandler.md
-a---- 5/22/2016 6:59 PM 3586 Get-PSReadLineOption.md
-a---- 5/22/2016 6:59 PM 1549 Remove-PSReadLineKeyHandler.md
-a---- 5/22/2016 6:59 PM 5947 Set-PSReadLineKeyHandler.md
-a---- 5/22/2016 6:59 PM 15320 Set-PSReadLineOption.md
-a---- 5/22/2016 6:59 PM 942 PSReadLine.md此命令为指定的帮助 MAML 文件创建 markdown 格式的帮助，如前面的示例所示。 此命令还指定 WithModulePage 参数和 ModuleName 参数。 该命令创建一个名为 PSReadLine.md 的文件，其中包含指向此模块中其他 markdown 文件的链接以及可用于创建 .cab 文件的元数据。
参数
-AlphabeticParamsOrder
在 PARAMETERS 节中按名称按字母顺序排列参数。 有 5 个例外：-Confirm、-WhatIf、-IncludeTotalCount、-Skip和 -First 参数将是最后一个。 这些参数很常见，因此具有明确定义的行为。
| 类型: | SwitchParameter |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-Command
指定当前会话中命令的名称。 这可以是 PowerShell 帮助支持的任何命令，例如 cmdlet 或函数。
| 类型: | String[] |
| Position: | Named |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | False |
| 接受通配符: | False |
-ConvertDoubleDashLists
指示此 cmdlet 将双连字符列表项目符号转换为单连字符项目符号。 Windows PowerShell 文档中常见的双连字符列表。 Markdown 接受列表的单连字符。
| 类型: | SwitchParameter |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-ConvertNotesToList
指示此 cmdlet 将 NOTES 部分中的多个段落项的格式设置为单列表项。
| 类型: | SwitchParameter |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-Encoding
指定外部帮助文件的字符编码。 指定 System.Text.Encoding 对象。 有关详细信息，请参阅 about_Character_Encoding。
| 类型: | Encoding |
| Position: | Named |
| 默认值: | UTF8 without BOM |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-ExcludeDontShow
从帮助内容中排除用 DontShow 标记的参数。
| 类型: | SwitchParameter |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-Force
指示此 cmdlet 覆盖具有相同名称的现有文件。
| 类型: | SwitchParameter |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-FwLink
指定模块页的转发链接。
.cab 文件创建需要此值。
此值用作模块页中的 markdown 标头元数据。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-HelpVersion
指定帮助的版本。
.cab 文件创建需要此值。 此值用作模块页中的 markdown 标头元数据。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-Locale
指定帮助的区域设置。 .cab 文件创建需要此值。 此值用作模块页中的 markdown 标头元数据。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-MamlFile
指定 MAML .xml 帮助文件的路径数组。
| 类型: | String[] |
| Position: | Named |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | False |
| 接受通配符: | False |
-Metadata
指定此 cmdlet 在帮助标记文件中作为字符串到 sting 键值对的哈希表中包含的元数据。 此 cmdlet 在每个 markdown 帮助文件的标头中写入元数据。
New-ExternalHelp cmdlet 不使用此元数据。 外部工具可以使用此元数据。
| 类型: | Hashtable |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-Module
指定此 cmdlet 以 markdown 格式创建帮助的模块的名称数组。
| 类型: | String[] |
| Position: | Named |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | True |
| 接受通配符: | False |
-ModuleGuid
指定帮助模块的 GUID。
.cab 文件创建需要此值。 此值用作模块页中的 markdown 标头元数据。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-ModuleName
指定帮助模块的名称。
.cab 文件创建需要此值。 此值用作模块页中的 markdown 标头元数据。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-ModulePagePath
WithModule 参数默认使用时，它将 .md 文件置于与所有其他文档相同的位置。使用此参数，可以指定新的名称/位置，从而提供更好的放置选项。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-NoMetadata
指示此 cmdlet 不会在生成的 markdown 中写入任何元数据。
| 类型: | SwitchParameter |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-OnlineVersionUrl
指定可更新帮助函数下载更新帮助的地址。 如果未指定值，cmdlet 将使用空字符串。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-OutputFolder
指定此 cmdlet 创建 markdown 帮助文件的文件夹的路径。
| 类型: | String |
| Position: | Named |
| 默认值: | None |
| 必需: | True |
| 接受管道输入: | False |
| 接受通配符: | False |
-Session
提供对远程命令的支持。 传递用于使用 Import-PSSession创建命令的会话。 这是从远程会话获取准确参数元数据所必需的。
| 类型: | PSSession |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-UseFullTypeName
指示目标文档将使用全类型名称，而不是参数的短名称。
| 类型: | SwitchParameter |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
-WithModulePage
指示此 cmdlet 在输出文件夹中创建模块页。 此文件具有 ModuleName 参数指定的名称。 如果未指定该参数，则 cmdlet 提供默认名称 MamlModule。 可以使用 ModulePagePath 覆盖此设置，以便为模块页定义不同的路径
| 类型: | SwitchParameter |
| Position: | Named |
| 默认值: | None |
| 必需: | False |
| 接受管道输入: | False |
| 接受通配符: | False |
输入
String[]
可以通过管道将模块名称传递给此 cmdlet。 这些模块是此 cmdlet 创建帮助 markdown 的模块。
输出
FileInfo[]
此 cmdlet 返回已创建文件的 FileInfo[] 对象。
