Build-PSBuildMarkdown

NAME Build-PSBuildMarkdown



SYNOPSIS

Creates PlatyPS markdown documents based on comment-based help of module.





SYNTAX

Build-PSBuildMarkdown [-ModulePath] <String> [-ModuleName] <String> [-DocsPath] <String> [-Locale] <String>

[<CommonParameters>]





DESCRIPTION

Creates PlatyPS markdown documents based on comment-based help of module.





PARAMETERS

-ModulePath <String>

The path to the module



Required? true

Position? 1

Default value

Accept pipeline input? false

Accept wildcard characters? false



-ModuleName <String>

The name of the module.



Required? true

Position? 2

Default value

Accept pipeline input? false

Accept wildcard characters? false



-DocsPath <String>

The path where PlatyPS markdown docs will be saved.



Required? true

Position? 3

Default value

Accept pipeline input? false

Accept wildcard characters? false



-Locale <String>

The locale to save the markdown docs.



Required? true

Position? 4

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-PSBuildMarkdown -ModulePath ./output/MyModule/0.1.0 -ModuleName MyModule -DocsPath ./docs -Locale en-US



Analysis the comment-based help of the MyModule module and create markdown documents under ./docs/en-US.











RELATED LINKS