Skip to content

Latest commit

 

History

History
111 lines (83 loc) · 2.62 KB

Get-HelpPreview.md

File metadata and controls

111 lines (83 loc) · 2.62 KB
external help file Module Name online version schema
platyPS-help.xml
platyPS
2.0.0

Get-HelpPreview

SYNOPSIS

Displays your generated external help as Get-Help output.

SYNTAX

Get-HelpPreview -Path <String[]> [-ConvertNotesToList] [-ConvertDoubleDashLists] [<CommonParameters>]

DESCRIPTION

The Get-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: Preview the PlatyPS help

PS C:\> $Help = Get-HelpPreview -Path ".\out\platyPS\en-US\PlatyPS-help.xml"

PS C:\> $Help.Name

Get-HelpPreview
Get-MarkdownMetadata
New-ExternalHelp
New-ExternalHelpCab
New-MarkdownHelp
Update-MarkdownHelp
Update-MarkdownHelpModule
Update-MarkdownHelpSchema

The first command creates a Help object for the the specified MAML file. The command stores it in the $Help variable.

The second command displays the Name property for each of the objects in $Help.

PARAMETERS

-Path

Specifies an array of paths of MAML external help files.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByValue)
Accept wildcard characters: True

-ConvertNotesToList

Indicates that this cmldet formats multiple paragraph items in the NOTES section as single list items. This output follows TechNet formatting.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-ConvertDoubleDashLists

Indicates that this cmldet converts double-hyphen list bullets into single-hyphen bullets. Double-hyphen lists are common in Windows PowerShell documentation. Markdown accepts single-hyphens for lists.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).

INPUTS

String[]

You can pipe an array of paths to this cmdlet.

OUTPUTS

Help Object

This cmdlet returns a Help object, which is the same output as Get-Help.

NOTES

RELATED LINKS