2022-11-17 20:02:26 +01:00
|
|
|
## The export-to-manuals.ps1 PowerShell Script
|
2021-11-08 21:36:42 +01:00
|
|
|
|
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-11-17 19:46:02 +01:00
|
|
|
Author: Markus Fleschutz | License: CC0
|
2021-11-08 21:36:42 +01:00
|
|
|
|
|
|
|
## Related Links
|
|
|
|
https://github.com/fleschutz/PowerShell
|
|
|
|
|
2022-11-17 20:02:26 +01:00
|
|
|
## Source Code
|
|
|
|
<#
|
|
|
|
.SYNOPSIS
|
|
|
|
Exports all scripts as manuals
|
|
|
|
.DESCRIPTION
|
|
|
|
This PowerShell script exports the comment based help of all PowerShell scripts as manuals.
|
|
|
|
.EXAMPLE
|
|
|
|
PS> ./export-to-manuals.ps1
|
|
|
|
Found 264 scripts, exporting them to /home/markus/PowerShell/Docs...
|
|
|
|
✔️ exported 264 PowerShell scripts in 28 sec
|
|
|
|
.LINK
|
|
|
|
https://github.com/fleschutz/PowerShell
|
|
|
|
.NOTES
|
|
|
|
Author: Markus Fleschutz | License: CC0
|
|
|
|
#>
|
|
|
|
|
|
|
|
#requires -version 2
|
|
|
|
|
|
|
|
param([string]$FilePattern = "$PSScriptRoot/*.ps1", [string]$TargetDir = "$PSScriptRoot/../Docs")
|
|
|
|
|
|
|
|
try {
|
|
|
|
$StopWatch = [system.diagnostics.stopwatch]::startNew()
|
|
|
|
|
|
|
|
$Scripts = Get-ChildItem "$FilePattern"
|
|
|
|
"⏳ Found $($Scripts.Count) scripts, exporting them to $TargetDir..."
|
|
|
|
|
|
|
|
foreach ($Script in $Scripts) {
|
|
|
|
& "$PSScriptRoot/convert-ps2md.ps1" "$Script" > "$TargetDir/$($Script.BaseName).md"
|
|
|
|
}
|
|
|
|
|
|
|
|
[int]$Elapsed = $StopWatch.Elapsed.TotalSeconds
|
|
|
|
"✔️ exported $($Scripts.Count) PowerShell scripts in $Elapsed sec"
|
|
|
|
exit 0 # success
|
|
|
|
} catch {
|
|
|
|
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
|
|
|
|
exit 1
|
|
|
|
}
|
|
|
|
|
2021-11-08 21:36:42 +01:00
|
|
|
*Generated by convert-ps2md.ps1 using the comment-based help of export-to-manuals.ps1*
|