forked from fleschutz/PowerShell
-
Notifications
You must be signed in to change notification settings - Fork 0
/
export-to-manuals.ps1
executable file
·38 lines (32 loc) · 1.18 KB
/
export-to-manuals.ps1
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
<#
.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
⏳ (1/2) Reading PowerShell scripts from /home/mf/PowerShell/Scripts/*.ps1 ...
⏳ (2/2) Exporting Markdown manuals to /home/mf/PowerShell/Scripts/../Docs ...
✔️ Exporting 518 Markdown manuals took 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()
"⏳ (1/2) Reading PowerShell scripts from $FilePattern ..."
$Scripts = Get-ChildItem "$FilePattern"
"⏳ (2/2) Exporting Markdown manuals to $TargetDir ..."
foreach ($Script in $Scripts) {
& "$PSScriptRoot/convert-ps2md.ps1" "$Script" > "$TargetDir/$($Script.BaseName).md"
}
[int]$Elapsed = $StopWatch.Elapsed.TotalSeconds
"✔️ Exporting $($Scripts.Count) Markdown manuals took $Elapsed sec"
exit 0 # success
} catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"
exit 1
}