Build-PSBuildMAMLHelp

NAME Build-PSBuildMAMLHelp



SYNOPSIS

Builds PowerShell MAML XML help file from PlatyPS markdown files





SYNTAX

Build-PSBuildMAMLHelp [-Path] <String> [-DestinationPath] <String> [<CommonParameters>]





DESCRIPTION

Builds PowerShell MAML XML help file from PlatyPS markdown files





PARAMETERS

-Path <String>

The path to the PlatyPS markdown documents.



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-DestinationPath <String>

The path to the output module directory.



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS



-------------------------- EXAMPLE 1 --------------------------



PS>Build-PSBuildMAMLHelp -Path ./docs -Destination ./output/MyModule



Uses PlatyPS to generate MAML XML help from markdown files in ./docs

and saves the XML file to a directory under ./output/MyModule











RELATED LINKS