New-MarkdownHelp
以 Markdown 格式建立說明。
Syntax
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>] Description
Cmdlet 會 New-MarkdownHelp 根據模組、命令或 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第一個命令會使用 Import-Module Cmdlet 將PlatyPS模組載入目前的會話。
第二個命令會為 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 參數會是最後一個。 這些參數很常見，因此具有妥善定義的行為。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Command
指定您目前會話中的命令名稱。 這可以是 PowerShell 說明所支援的任何命令，例如 Cmdlet 或函式。
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ConvertDoubleDashLists
表示此 Cmdlet 會將雙連字號清單專案符號轉換成單一連字號專案符號。 雙連字號清單在Windows PowerShell檔中很常見。 Markdown 接受清單的單一連字號。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ConvertNotesToList
指出此 Cmdlet 會將 NOTES 區段中的多個段落專案格式化為單一清單專案。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Encoding
指定外部說明檔的字元編碼。 指定 System.Text.Encoding 物件。 如需詳細資訊，請參閱 about_Character_Encoding。
| Type: | Encoding |
| Position: | Named |
| Default value: | UTF8 without BOM |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ExcludeDontShow
從說明內容中排除參數屬性中標示 DontShow 的參數。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Force
指出此 Cmdlet 會覆寫具有相同名稱的現有檔案。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FwLink
指定模組頁面的向前連結。 建立檔案時 .cab 需要這個值。
此值會當做模組頁面中的 Markdown 標頭中繼資料使用。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-HelpVersion
指定說明的版本。 建立檔案時 .cab 需要這個值。 此值會當做模組頁面中的 Markdown 標頭中繼資料使用。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Locale
指定說明的地區設定。 建立檔案 .cab 需要這個值。 此值會當做模組頁面中的 Markdown 標頭中繼資料使用。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MamlFile
指定 MAML .xml 說明檔的路徑路徑陣列。
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Metadata
指定此 Cmdlet 在說明 Markdown 檔案中所包含的中繼資料，做為字串對 sting 索引鍵/值組的雜湊表。 此 Cmdlet 會在每個 Markdown 說明檔的標頭中寫入中繼資料。
Cmdlet New-ExternalHelp 不會使用此中繼資料。 外部工具可以使用此中繼資料。
| Type: | Hashtable |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Module
指定此 Cmdlet 以 Markdown 格式建立說明的模組名稱陣列。
| Type: | String[] |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-ModuleGuid
指定說明模組的 GUID。 建立檔案時 .cab 需要這個值。 此值會當做模組頁面中的 Markdown 標頭中繼資料使用。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ModuleName
指定說明模組的名稱。 建立檔案時 .cab 需要這個值。 此值會當做模組頁面中的 Markdown 標頭中繼資料使用。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ModulePagePath
使用 WithModule 參數時，預設會將 .md 檔案放在與所有其他檔相同的位置。使用此參數，您可以指定提供更佳位置選項的新名稱/位置。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NoMetadata
表示此 Cmdlet 不會在產生的 Markdown 中寫入任何中繼資料。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OnlineVersionUrl
指定可更新說明函式下載已更新說明的位址。 如果您未指定值，Cmdlet 會使用空字串。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OutputFolder
指定此 Cmdlet 建立 Markdown 說明檔的資料夾路徑。
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Session
提供遠端命令的支援。 傳遞您用來使用 Import-PSSession 建立命令的會話。 這是從遠端會話取得精確參數中繼資料的必要專案。
| Type: | PSSession |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseFullTypeName
指出目的檔案會使用完整類型名稱，而不是參數的簡短名稱。
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WithModulePage
表示此 Cmdlet 會在輸出檔案夾中建立模組頁面。 此檔案具有 ModuleName 參數指定的名稱。 如果您未指定該參數，Cmdlet 會提供預設名稱 MamlModule 。 您可以使用 ModulePagePath 覆寫此設定，這可讓您定義模組頁面的不同路徑
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
輸入
String[]
您可以使用管線將模組名稱傳送至此 Cmdlet。 這些是此 Cmdlet 建立說明 Markdown 的模組。
輸出
FileInfo[]
此 Cmdlet 會傳回已建立檔案的 FileInfo[] 物件。
