2023-10-31 12:20:46 +01:00
|
|
|
|
<#
|
2021-10-09 09:34:26 +02:00
|
|
|
|
.SYNOPSIS
|
2021-10-10 09:46:38 +02:00
|
|
|
|
Exports all scripts as manuals
|
2021-10-09 09:34:26 +02:00
|
|
|
|
.DESCRIPTION
|
2024-01-25 13:36:21 +01:00
|
|
|
|
This PowerShell script exports the comment-based help of all PowerShell scripts as manuals.
|
2021-10-09 09:34:26 +02:00
|
|
|
|
.EXAMPLE
|
2021-10-10 10:57:45 +02:00
|
|
|
|
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 ...
|
2024-01-25 13:36:21 +01:00
|
|
|
|
✔️ Exported 518 Markdown manuals in 28 sec.
|
2021-10-09 09:34:26 +02:00
|
|
|
|
.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-09 09:34:26 +02:00
|
|
|
|
#>
|
|
|
|
|
|
2021-10-10 09:24:31 +02:00
|
|
|
|
#requires -version 2
|
2021-10-09 09:34:26 +02:00
|
|
|
|
|
2024-01-25 13:36:21 +01:00
|
|
|
|
param([string]$filePattern = "$PSScriptRoot/*.ps1", [string]$targetDir = "$PSScriptRoot/../docs")
|
2021-10-09 09:34:26 +02:00
|
|
|
|
|
|
|
|
|
try {
|
2024-01-25 13:36:21 +01:00
|
|
|
|
$stopWatch = [system.diagnostics.stopwatch]::startNew()
|
2021-10-10 09:24:31 +02:00
|
|
|
|
|
2024-01-25 13:36:21 +01:00
|
|
|
|
"⏳ (1/2) Reading PowerShell scripts from $filePattern ..."
|
|
|
|
|
$scripts = Get-ChildItem "$filePattern"
|
2021-10-10 09:24:31 +02:00
|
|
|
|
|
2024-01-25 13:36:21 +01:00
|
|
|
|
"⏳ (2/2) Exporting Markdown manuals to $targetDir ..."
|
|
|
|
|
foreach ($script in $scripts) {
|
|
|
|
|
& "$PSScriptRoot/convert-ps2md.ps1" "$script" > "$targetDir/$($script.BaseName).md"
|
2021-10-10 09:24:31 +02:00
|
|
|
|
}
|
2021-10-09 09:34:26 +02:00
|
|
|
|
|
2024-01-25 13:36:21 +01:00
|
|
|
|
[int]$elapsed = $stopWatch.Elapsed.TotalSeconds
|
|
|
|
|
"✔️ Exported $($scripts.Count) Markdown manuals in $elapsed sec."
|
2021-10-10 09:46:38 +02:00
|
|
|
|
exit 0 # success
|
2021-10-09 09:34:26 +02:00
|
|
|
|
} catch {
|
2022-04-13 12:06:32 +02:00
|
|
|
|
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
|
2021-10-09 09:34:26 +02:00
|
|
|
|
exit 1
|
|
|
|
|
}
|