共用方式為


New-MarkdownModuleFile

建立 PowerShell 模組的 Markdown 模組檔案。

語法

__AllParameterSets

New-MarkdownModuleFile
    -OutputFolder <string>
    [-CommandHelp <CommandHelp[]>]
    [-Encoding <Encoding>]
    [-Force]
    [-HelpInfoUri <string>]
    [-HelpVersion <version>]
    [-Locale <string>]
    [-Metadata <hashtable>]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

此命令會建立PowerShell模組的 Markdown 模組檔案。 模組檔案包含模組元數據,以及具有其摘要描述的所有命令清單。 此檔案可作為檔集中的模組登陸頁面。 模組元數據可用來建立模組的MAML說明檔 Export-MamlCommandHelp

範例

範例 1 - 從命令說明檔的資料夾建立新的模組檔案

$mdfiles = Measure-PlatyPSMarkdown -Path .\v2\Microsoft.PowerShell.PlatyPS\*.md
$mdfiles | Where-Object Filetype -match 'CommandHelp' |
    Import-MarkdownCommandHelp -Path {$_.FilePath} |
    New-MarkdownModuleFile -OutputFolder .\v2 -Force
    Directory: D:\Docs\v2\Microsoft.PowerShell.PlatyPS

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---           9/18/2024  1:49 PM           2129 Microsoft.PowerShell.PlatyPS.md

範例 2 - 從命令清單建立新的模組檔案

$newMarkdownCommandHelpSplat = @{
    CommandHelp  = Get-Command -Module Microsoft.PowerShell.PlatyPS | New-CommandHelp
    OutputFolder = '.\new'
    Force        = $true
}
New-MarkdownModuleFile @newMarkdownCommandHelpSplat
    Directory: D:\Docs\new\Microsoft.PowerShell.PlatyPS

Mode                 LastWriteTime         Length Name
----                 -------------         ------ ----
-a---           9/18/2024  1:49 PM           2129 Microsoft.PowerShell.PlatyPS.md

參數

-CommandHelp

CommandHelp 要包含在模組檔案中的物件。 您可以傳遞管線上的 CommandHelp 物件,或使用 Command 參數。

參數屬性

類型:

Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]

預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:True
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Confirm

在執行 Cmdlet 之前,提示您進行確認。

參數屬性

類型:SwitchParameter
預設值:False
支援萬用字元:False
不要顯示:False
別名:cf

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Encoding

建立輸出檔案時所使用的編碼方式。 如果未指定,Cmdlet 會使用 $OutputEncoding所指定的值。

參數屬性

類型:Encoding
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-Force

根據預設,此命令不會覆寫現有的檔案。 當您使用此參數時,Cmdlet 會覆寫現有的檔案。

參數屬性

類型:SwitchParameter
預設值:False
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-HelpInfoUri

此參數可讓您指定用於可更新說明的 URI。 根據預設,Cmdlet 會使用模組指令清單中指定的 HelpInfoUri。

參數屬性

類型: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

-Metadata

要新增至 Markdown 檔案前端的元數據。 元數據是哈希表,您可以在其中指定要新增至frontmatter的索引鍵和值組。 新的索引鍵名稱會新增至現有的前端。 會覆寫現有索引鍵的值。 您無法覆寫 document typePlatyPS schema version 索引鍵的值。 如果這些索引鍵存在於哈希表中,Cmdlet 會忽略值並輸出警告。

參數屬性

類型:Hashtable
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-OutputFolder

指定 Markdown 模組檔案寫入位置。 Cmdlet 會根據所處理 CommandHelp 物件,為每個模組建立資料夾。

參數屬性

類型:String
預設值:None
支援萬用字元:False
不要顯示:False

參數集

(All)
Position:Named
必要:True
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

-WhatIf

在僅報告將發生的情況而不執行作的模式下運行命令。

參數屬性

類型:SwitchParameter
預設值:False
支援萬用字元:False
不要顯示:False
別名:無線

參數集

(All)
Position:Named
必要:False
來自管線的值:False
來自管線按屬性名稱的值:False
來自剩餘引數的值:False

CommonParameters

此 Cmdlet 支援一般參數:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 如需詳細資訊,請參閱 about_CommonParameters

輸入

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

輸出

FileInfo