| Author | external help file | Module Guid | Module Name | online version | schema |
|---|---|---|---|---|---|
Paul Boyer |
PSVault-Documentation-help.xml |
f161ba1f-1962-435c-b32c-8433dc61b203 |
PSVault-Documentation |
2.0.0 |
Script used for generating Markdown documentation for PowerShell files.
Export-ModuleDocs -Path <String> [-ModulePrefix <String>] [-Exclude <String[]>] [-Version <String>] [-Prune]
[<CommonParameters>]
Export-ModuleDocs -Path <String> -ModuleDescription <String> [-Exclude <String[]>] [-Version <String>] [-Prune]
[<CommonParameters>]
Export-ModuleDocs -Path <String> [-ModuleDescriptionFile <String>] [-Exclude <String[]>] [-Version <String>]
[-Prune] [<CommonParameters>]
Export-ModuleDocs -Path <String> -MarkdownFilesPath <String> [-Exclude <String[]>] [-Version <String>] [-Prune]
[<CommonParameters>]
Export-ModuleDocs -Path <String> [-Exclude <String[]>] [-NoClobber] -ModuleFilePath <String>
[-Version <String>] [-Prune] [<CommonParameters>]
Export-ModuleDocs -Path <String> [-Exclude <String[]>] [-NoModulePrefix] [-Version <String>] [-Prune]
[<CommonParameters>]
The script leverages the PlatyPS module to generate Markdown files for each PS1 file as well as for the whole module. The script also generates a relatively-pathed PSM1 file, and complimentary PSD1 file.
Export-ModuleDocs -Path ".\Windows10" -ModuleDescription "Windows 10 PowerShell Scripts"
Export-ModuleDocs -Path ".\Windows10" -ModuleDescriptionFile ".\Windows10\Description.txt"
Export-ModuleDocs -Path ".\Windows10" -ModuleDescription "Windows 10 PowerShell Scripts" -MarkdownFilesPath ".\Windows10\Markdown" -NoModulePrefix
Export-ModuleDocs -Path ".\Windows10" -ModuleDescription "Windows 10 PowerShell Scripts" -NoCobber -ModuleFilePath ".\Windows10\Module.psm1" -NoModulePrefix
Path to the directory containing PowerShell (PS1) files to generate documentation for.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseString to be pre-fixed to the beginning of the generated PSM1,PSD1, and used in the ReadMe file.
Type: String
Parameter Sets: Module_Prefix
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseThe description that should be used in the PSD1 file and ReadMe file for the Module.
Type: String
Parameter Sets: Description_String
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePath to a file containing the description that should be used in the PSD1 file and ReadMe file for the Module. Optionally, specify an empty string (""), and the script will attempt to use the "$Path\Description.txt" to get the Module description. This is helpful for keeping the same description in place when updating documentation through multiple revisions.
Type: String
Parameter Sets: Description_File
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePath to the directory where Markdown files for each PS1 script should be stored. By default, the script will save the files to $Path\Docs
Type: String
Parameter Sets: MarkdownFiles_Path
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseString array of paths to exclude when getting PowerShell (PS1) files to document.
Type: String[]
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseNo not overwrite existing PSM1 and PSD1 files. A value must be supplied for -ModuleFilePath in order to user -NoClobber
Type: SwitchParameter
Parameter Sets: NoClobber
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalsePath to the existing module file. Script is expecting a PSM1 file.
Type: String
Parameter Sets: NoClobber
Aliases:
Required: True
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalseSwitch to exclude application of a module prefix to the beginning of the generated PSM1,PSD1, and used in the ReadMe file.
Type: SwitchParameter
Parameter Sets: Module_NoPrefix
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: FalseSpecify a string to represent the revision of the help documentation. This will also be applied to the PSD1 manifest file.
Type: String
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False{{ Fill Prune Description }}
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
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.
Author: Paul Boyer Date: 5-11-2021