| 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 that updates the README file on the front page.
Compile-ModuleDocs [-Path] <String> [-OutFile] <String> [<CommonParameters>]
Script pulls data from the individual README files in each folder and consolidates them into one README for the front page. Script also changes the paths in the consolidated file so that they can be resolved from the front page.
Compile-ModuleDocs -Path C:\Scripts -OutFile C:\Scripts\Readme.md
Path to working directory containing sub-folders with scripts and README files.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 1
Default value: None
Accept pipeline input: False
Accept wildcard characters: FalsePath to where the consolidated file should be saved.
Type: String
Parameter Sets: (All)
Aliases:
Required: True
Position: 2
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.
Author: Paul Boyer Date: 5-12-21