PowerShell/scripts/export-to-manuals.ps1

39 lines
1.2 KiB
PowerShell
Raw Normal View History

2023-10-31 12:20:46 +01:00
<#
.SYNOPSIS
Exports all scripts as manuals
.DESCRIPTION
2022-01-29 12:47:46 +01:00
This PowerShell script exports the comment based help of all PowerShell scripts as manuals.
.EXAMPLE
PS> ./export-to-manuals.ps1
2023-10-31 11:32:46 +01:00
(1/2) Reading PowerShell scripts from /home/mf/PowerShell/scripts/*.ps1 ...
2023-10-31 11:05:01 +01:00
(2/2) Exporting Markdown manuals to /home/mf/PowerShell/docs ...
2023-09-01 17:53:03 +02:00
Exported 518 Markdown manuals in 28 sec
.LINK
2021-10-10 09:24:31 +02:00
https://github.com/fleschutz/PowerShell
2022-01-29 12:47:46 +01:00
.NOTES
2022-09-06 21:42:04 +02:00
Author: Markus Fleschutz | License: CC0
#>
2021-10-10 09:24:31 +02:00
#requires -version 2
2023-10-31 11:05:01 +01:00
param([string]$FilePattern = "$PSScriptRoot/*.ps1", [string]$TargetDir = "$PSScriptRoot/../docs")
try {
2021-10-10 09:24:31 +02:00
$StopWatch = [system.diagnostics.stopwatch]::startNew()
2023-05-26 12:20:18 +02:00
"⏳ (1/2) Reading PowerShell scripts from $FilePattern ..."
2021-10-10 09:24:31 +02:00
$Scripts = Get-ChildItem "$FilePattern"
2023-05-26 12:20:18 +02:00
"⏳ (2/2) Exporting Markdown manuals to $TargetDir ..."
2021-10-10 09:24:31 +02:00
foreach ($Script in $Scripts) {
2021-11-15 07:38:37 +01:00
& "$PSScriptRoot/convert-ps2md.ps1" "$Script" > "$TargetDir/$($Script.BaseName).md"
2021-10-10 09:24:31 +02:00
}
2021-10-10 09:24:31 +02:00
[int]$Elapsed = $StopWatch.Elapsed.TotalSeconds
2023-09-01 17:53:03 +02:00
"✔️ Exported $($Scripts.Count) Markdown manuals in $Elapsed sec"
exit 0 # success
} catch {
2022-04-13 12:06:32 +02:00
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}