通过

Update-MarkdownModuleFile

模块:
Microsoft.PowerShell.PlatyPS Module

更新 Markdown 模块文件。

语法

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>]

说明

此 cmdlet 使用 CommandHelp 更新 Markdown 模块文件， 从 Markdown 命令文件导入的对象信息。

示例

示例 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 对象。

参数属性

类型:

Microsoft.PowerShell.PlatyPS.Model.CommandHelp[]

默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:1
必需:True
来自管道的值:True
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Confirm

在运行 cmdlet 之前，提示你进行确认。

参数属性

类型:SwitchParameter
默认值:False
支持通配符:False
不显示:False
别名:cf

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Encoding

写入 markdown 文件时要使用的编码。 如果未指定任何值，则编码默认为 $OutputEncoding 首选项变量的值。

参数属性

类型:Encoding
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Force

使用 Force 参数覆盖输出文件（如果已存在）。

参数属性

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

-LiteralPath

指定一个或多个模块 Markdown 文件的路径。 LiteralPath 的值与类型化完全相同。 不会将任何字符解释为通配符。 如果路径包含转义字符，请将它括在单引号中。 单引号告知 PowerShell 不要将任何字符解释为转义序列。

有关详细信息，请参阅 about_Quoting_Rules。

参数属性

类型:String
默认值:False
支持通配符:False
不显示:False
别名:PSPath, LP

参数集

literalpath
Position:Named
必需:True
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Locale

此参数允许指定帮助文件的语言区域设置。 默认情况下，cmdlet 使用当前 CultureInfo。 使用 Get-Culture cmdlet 查看系统上的当前区域性设置。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Metadata

要添加到 markdown 文件的 frontmatter 的元数据。 元数据是一个哈希表，可在其中指定要添加到 frontmatter 的键和值对。 新键名称将添加到现有 frontmatter。 覆盖现有键的值。 不能覆盖 document type 或 PlatyPS schema version 键的值。 如果这些键存在于哈希表中，则 cmdlet 将忽略这些值并输出警告。

参数属性

类型:Hashtable
默认值:None
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-NoBackup

默认情况下，该 cmdlet 会在更新之前创建原始 Markdown 文件的备份。 使用此参数禁止创建备份文件。

参数属性

类型:SwitchParameter
默认值:False
支持通配符:False
不显示:False

参数集

(All)
Position:Named
必需:False
来自管道的值:False
来自管道的值（按属性名称）:False
来自剩余参数的值:False

-Path

指定一个或多个模块 Markdown 文件的路径。

参数属性

类型:String
默认值:None
支持通配符:False
不显示:False

参数集

path
Position:0
必需: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