Import-MarkdownModuleFile
将 Markdown 模块文件导入 ModuleHelp 对象。
语法
Path (默认值)
Import-MarkdownModuleFile
[-Path] <string[]>
[<CommonParameters>]
LiteralPath
Import-MarkdownModuleFile
-LiteralPath <string[]>
[<CommonParameters>]
说明
该命令导入包含模块帮助的 Markdown 文件,并创建 ModuleHelp 对象。 ModuleHelp 对象是可用于导出到不同格式的帮助内容的结构化表示形式。
示例
示例 1 - 转换
Import-MarkdownModuleFile .\v2\Microsoft.PowerShell.PlatyPS\Microsoft.PowerShell.PlatyPS.md
Metadata : {[document type, module], [HelpInfoUri, ], [Locale, en-US], [Module Guid,
0bdcabef-a4b7-4a6d-bf7e-d879817ebbff]…}
Title : Microsoft.PowerShell.PlatyPS Module
Module : Microsoft.PowerShell.PlatyPS
ModuleGuid : 0bdcabef-a4b7-4a6d-bf7e-d879817ebbff
Description : This module contains cmdlets to help with the creation help content for PowerShell commands.
Locale : en-US
CommandGroups : {Microsoft.PowerShell.PlatyPS.ModuleCommandGroup}
Diagnostics : Microsoft.PowerShell.PlatyPS.Model.Diagnostics
参数
-LiteralPath
指定包含 markdown 文件的一个或多个位置的路径。 LiteralPath 的值严格按照所键入的形式使用。 不会将任何字符解释为通配符。 如果路径包含转义字符,请将它括在单引号中。 单引号告知 PowerShell 不要将任何字符解释为转义序列。
有关详细信息,请参阅 about_Quoting_Rules。
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | False |
| 不显示: | False |
| 别名: | PSPath, LP |
参数集
LiteralPath
| Position: | Named |
| 必需: | True |
| 来自管道的值: | True |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
-Path
指定项的路径。 此 cmdlet 获取位于指定位置的项。 允许使用通配符。 此参数是必需的,但参数名称 Path 是可选的。
使用点(.)指定当前位置。 使用通配符(*)指定当前位置的所有项。
参数属性
| 类型: | String[] |
| 默认值: | None |
| 支持通配符: | True |
| 不显示: | False |
参数集
Path
| Position: | 0 |
| 必需: | True |
| 来自管道的值: | True |
| 来自管道的值(按属性名称): | False |
| 来自剩余参数的值: | False |
CommonParameters
此 cmdlet 支持通用参数:-Debug、-ErrorAction、-ErrorVariable、-InformationAction、-InformationVariable、-OutBuffer、-OutVariable、-PipelineVariable、-ProgressAction、-Verbose、-WarningAction 和 -WarningVariable。 有关详细信息,请参阅 about_CommonParameters。