Update-MarkdownModuleFile

語法

path

Update-MarkdownModuleFile
    [-Path] <string>
    [-CommandHelp] <CommandHelp[]>
    [-Encoding <Encoding>]
    [-Force]
    [-HelpInfoUri <string>]
    [-HelpVersion <version>]
    [-Locale <string>]
    [-Metadata <hashtable>]
    [-NoBackup]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

literalpath

Update-MarkdownModuleFile
    [-CommandHelp] <CommandHelp[]>
    -LiteralPath <string>
    [-Encoding <Encoding>]
    [-Force]
    [-HelpInfoUri <string>]
    [-HelpVersion <version>]
    [-Locale <string>]
    [-Metadata <hashtable>]
    [-NoBackup]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

Description

範例

範例 1 - 從新的命令說明檔更新模組檔案

$mdfiles = Measure-PlatyPSMarkdown -Path .\Microsoft.PowerShell.PlatyPS\*.md
$mdfiles | Where-Object Filetype -match 'CommandHelp' |
    Import-MarkdownCommandHelp -Path {$_.FilePath} |
    Update-MarkdownModuleFile -Path .\Microsoft.PowerShell.PlatyPS\Microsoft.PowerShell.PlatyPS.md

參數

-CommandHelp

要匯出 CommandHelp 物件。 您可以在管線上或使用此參數，傳遞 CommandHelp 物件。

參數屬性

參數集

-Confirm

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

參數屬性

參數集

-Encoding

寫入 Markdown 檔案時要使用的編碼方式。 如果未指定任何值，編碼會預設為 $OutputEncoding 喜好設定變數的值。

參數屬性

參數集

-Force

使用 Force 參數，在輸出檔案已經存在時覆寫輸出檔案。

參數屬性

參數集

-HelpInfoUri

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

參數屬性

參數集

-HelpVersion

此參數可讓您指定說明的版本。 預設值是 1.0.0.0。 此版本會寫入用於可更新說明的 HelpInfo.xml 檔案。

參數屬性

參數集

-LiteralPath

指定一或多個模組 Markdown 檔案的路徑。 LiteralPath 的值會被原樣使用，不做任何更改。 不會將任何字元解譯為通配符。 如果路徑包含逸出字元，請以單引弧括住它。 單引號會告知PowerShell不要將任何字元解譯為逸出序列。

如需詳細資訊，請參閱 about_Quoting_Rules。

參數屬性

參數集

-Locale

此參數可讓您指定說明檔的語言地區設定。 根據預設，Cmdlet 會使用目前 CultureInfo。 使用 Get-Culture Cmdlet 來查看您系統上目前的文化特性設定。

參數屬性

參數集

-Metadata

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

參數屬性

參數集

-NoBackup

根據預設，Cmdlet 會先建立原始 Markdown 檔案的備份，再進行更新。 使用此參數來隱藏備份檔的建立。

參數屬性

參數集

-Path

指定一或多個模組 Markdown 檔案的路徑。

參數屬性

參數集

-WhatIf

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

參數屬性

參數集

CommonParameters

輸入

Microsoft.PowerShell.PlatyPS.Model.CommandHelp

輸出

FileInfo

相關連結

• New-MarkdownModuleFile