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>]
Description
建立 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的索引鍵和值組。 新的索引鍵名稱會新增至現有的前端。 會覆寫現有索引鍵的值。 您無法覆寫 document type 或 PlatyPS schema version 索引鍵的值。 如果這些索引鍵存在於哈希表中，Cmdlet 會忽略值並輸出警告。
| 類型: | Hashtable
|
| 預設值: | None |
| 支援萬用字元: | False |
| 不要顯示: | False |
(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。
輸出