Show-HelpPreview
View MAML file contents as it would appear when output by Get-Help.
Syntax
Path
Show-HelpPreview
[-Path] <string[]>
[-ConvertNotesToList]
[-ConvertDoubleDashLists]
[<CommonParameters>]
LiteralPath
Show-HelpPreview
[-LiteralPath] <string[]>
[-ConvertNotesToList]
[-ConvertDoubleDashLists]
[<CommonParameters>]
Description
The Show-HelpPreview cmdlet displays your generated external help as Get-Help output. Specify
one or more files in Microsoft Assistance Markup Language (MAML) format.
Examples
Example 1 - Display the contents of a MAML file
This example displays the contents of PlatyPS MAML file as it would appear when output by
Get-Help.
Show-HelpPreview -Path .\Microsoft.PowerShell.PlatyPS\Microsoft.PowerShell.PlatyPS-Help.xml
Parameters
-ConvertDoubleDashLists
Indicates that this cmdlet converts double-hyphen list bullets into single-hyphen bullets. Double-hyphen lists are common in Windows PowerShell documentation. Markdown accepts single-hyphens for lists.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-ConvertNotesToList
Indicates that this cmdlet formats multiple paragraph items in the NOTES section as single list items.
Parameter properties
| Type: | SwitchParameter |
| Default value: | False |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | False |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-LiteralPath
Specifies one or more paths to MAML help files. Wildcards aren't supported.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | PSPath, LP |
Parameter sets
LiteralPath
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Path
Specifies one or more paths to MAML help files. Wildcards are supported.
Parameter properties
| Type: | String[] |
| Default value: | None |
| Supports wildcards: | True |
| DontShow: | False |
Parameter sets
Path
| Position: | 1 |
| Mandatory: | True |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
String
Outputs
MamlCommandHelpInfo
This cmdlet returns a MamlCommandHelpInfo objects. This is the same object that is returned by
Get-Help.