New-MarkdownHelp

New-MarkdownHelp
    -Module <String[]>
    -OutputFolder <String>
    [-Session <PSSession>]
    [-Force]
    [-AlphabeticParamsOrder]
    [-Metadata <Hashtable>]
    [-NoMetadata]
    [-UseFullTypeName]
    [-Encoding <Encoding>]
    [-WithModulePage]
    [-ModulePagePath <String>]
    [-Locale <String>]
    [-HelpVersion <String>]
    [-FwLink <String>]
    [-ExcludeDontShow]
    [<CommonParameters>]

New-MarkdownHelp
    -Command <String[]>
    -OutputFolder <String>
    [-Session <PSSession>]
    [-Force]
    [-AlphabeticParamsOrder]
    [-Metadata <Hashtable>]
    [-OnlineVersionUrl <String>]
    [-NoMetadata]
    [-UseFullTypeName]
    [-Encoding <Encoding>]
    [-ExcludeDontShow]
    [<CommonParameters>]

New-MarkdownHelp
    -MamlFile <String[]>
    -OutputFolder <String>
    [-ConvertNotesToList]
    [-ConvertDoubleDashLists]
    [-Force]
    [-AlphabeticParamsOrder]
    [-Metadata <Hashtable>]
    [-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 格式创建帮助。

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 文件夹中的存根函数创建帮助。

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 文件。

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 文件（而不是当前安装的模块）创建帮助。

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 文件的元数据。

此 cmdlet 支持通用参数：-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息，请参阅 about_CommonParameters。

可以通过管道将模块名称传递给此 cmdlet。 这些模块是此 cmdlet 创建帮助 markdown 的模块。

此 cmdlet 返回已创建文件的 FileInfo[] 对象。