2021-11-08 21:36:42 +01:00
|
|
|
## export-to-manuals.ps1 - Exports all scripts as manuals
|
|
|
|
|
2022-02-10 09:01:07 +01:00
|
|
|
This PowerShell script exports the comment based help of all PowerShell scripts as manuals.
|
2021-11-08 21:36:42 +01:00
|
|
|
|
|
|
|
## Parameters
|
|
|
|
```powershell
|
2021-12-09 16:19:09 +01:00
|
|
|
export-to-manuals.ps1 [[-FilePattern] <String>] [[-TargetDir] <String>] [<CommonParameters>]
|
2021-11-08 21:36:42 +01:00
|
|
|
|
|
|
|
-FilePattern <String>
|
|
|
|
|
|
|
|
Required? false
|
|
|
|
Position? 1
|
|
|
|
Default value "$PSScriptRoot/*.ps1"
|
|
|
|
Accept pipeline input? false
|
|
|
|
Accept wildcard characters? false
|
|
|
|
|
|
|
|
-TargetDir <String>
|
|
|
|
|
|
|
|
Required? false
|
|
|
|
Position? 2
|
|
|
|
Default value "$PSScriptRoot/../Docs"
|
|
|
|
Accept pipeline input? false
|
|
|
|
Accept wildcard characters? false
|
|
|
|
|
|
|
|
[<CommonParameters>]
|
|
|
|
This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction,
|
|
|
|
WarningVariable, OutBuffer, PipelineVariable, and OutVariable.
|
|
|
|
```
|
|
|
|
|
|
|
|
## Example
|
|
|
|
```powershell
|
|
|
|
PS> ./export-to-manuals.ps1
|
|
|
|
Found 264 scripts, exporting them to /home/markus/PowerShell/Docs...
|
|
|
|
✔️ exported 264 PowerShell scripts in 28 sec
|
|
|
|
|
|
|
|
```
|
|
|
|
|
|
|
|
## Notes
|
2022-02-10 09:01:07 +01:00
|
|
|
Author: Markus Fleschutz / License: CC0
|
2021-11-08 21:36:42 +01:00
|
|
|
|
|
|
|
## Related Links
|
|
|
|
https://github.com/fleschutz/PowerShell
|
|
|
|
|
|
|
|
*Generated by convert-ps2md.ps1 using the comment-based help of export-to-manuals.ps1*
|