| external help file | Module Name | online version | schema |
|---|---|---|---|
PowerBolt-help.xml |
PowerBolt |
2.0.0 |
Creates or updates help documentation files and module's README file. Also creates a XML based help documentation file for PowerShell.
Build-Documentation [[-Path] <String>] [-MarkdownFolder <String>] [-Locale <String>]
[-OnlineVersionUrlTemplate <String>] [-OnlineVersionUrlPolicy <String>] [-NoReImportModule] [-Force]
[<CommonParameters>]
Build-Documentation [-MarkdownFolder <String>] [-Locale <String>] [-OnlineVersionUrlTemplate <String>]
[-OnlineVersionUrlPolicy <String>] [-NoReImportModule] [-Force] [-Name] <String> [<CommonParameters>]
With required PlatyPS module, this function will generate Markdown help documentation files (such as the file where you are reading this from) and update or create a README.md file with new functions from the help docs. Also this generates a new PowerShell help doc file that is used in the CLI.
PS C:\Users\Alice\PowerSploit> Build-DocumentationBuilds documentation for the PowerSploit module with default parameters.
{{Fill Force Description}}
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe name of the folder where PowerShell XML file will reside.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: en-US
Accept pipeline input: False
Accept wildcard characters: FalseA relative path of module's folder where the Markdown files reside or will reside.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: docs
Accept pipeline input: False
Accept wildcard characters: FalseIf the module is already imported, the value is the name of the module.
Type: String
Parameter Sets: ByName
Aliases:
Accepted values: CimCmdlets, Microsoft.PowerShell.Management, Microsoft.PowerShell.Utility, Pester, Plaster, platyPS, posh-git, PowerBolt, PSReadLine
Required: True
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseBy default this function will re-import module to get the latest changes to that modules source code.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False{{Fill OnlineVersionUrlPolicy Description}}
Type: String
Parameter Sets: (All)
Aliases:
Accepted values: Auto, Omit
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False{{Fill OnlineVersionUrlTemplate Description}}
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseFolder that contains a module.
Type: String
Parameter Sets: ByPath
Aliases:
Required: False
Position: 0
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThis 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).