次の方法で共有

Show-HelpPreview

モジュール:
Microsoft.PowerShell.PlatyPS Module

View MAML file contents as it would appear when output by Get-Help.

構文

Path 

Show-HelpPreview
    [-Path] <string[]>
    [-ConvertNotesToList]
    [-ConvertDoubleDashLists]
    [<CommonParameters>]

LiteralPath 

Show-HelpPreview
    [-LiteralPath] <string[]>
    [-ConvertNotesToList]
    [-ConvertDoubleDashLists]
    [<CommonParameters>]

説明

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.

例

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

パラメーター

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

パラメーターのプロパティ

型:SwitchParameter
規定値:False
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-ConvertNotesToList

Indicates that this cmdlet formats multiple paragraph items in the NOTES section as single list items.

パラメーターのプロパティ

型:SwitchParameter
規定値:False
ワイルドカードのサポート:False
DontShow:False

パラメーター セット

(All)
配置:Named
必須:False
パイプラインからの値:False
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-LiteralPath

Specifies one or more paths to MAML help files. Wildcards aren't supported.

パラメーターのプロパティ

型:

String[]

規定値:None
ワイルドカードのサポート:False
DontShow:False
Aliases:LP, PSPath

パラメーター セット

LiteralPath
配置:Named
必須:True
パイプラインからの値:True
プロパティ名別のパイプラインからの値:False
残りの引数からの値:False

-Path

Specifies one or more paths to MAML help files. Wildcards are supported.

パラメーターのプロパティ

型:

String[]

規定値:None
ワイルドカードのサポート:True
DontShow:False

パラメーター セット

Path
配置:0
必須:True
パイプラインからの値:True
プロパティ名別のパイプラインからの値:False
残りの引数からの値: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.

入力

String

You can pipe path strings to this command.

出力

MamlCommandHelpInfo

This cmdlet returns a MamlCommandHelpInfo objects. This is the same object that is returned by Get-Help.