Script: *export-to-manuals.ps1* ======================== This PowerShell script exports the comment-based help of all PowerShell scripts as manuals. Parameters ---------- ```powershell PS> ./export-to-manuals.ps1 [[-filePattern] ] [[-targetDir] ] [] -filePattern Required? false Position? 1 Default value "$PSScriptRoot/*.ps1" Accept pipeline input? false Accept wildcard characters? false -targetDir Required? false Position? 2 Default value "$PSScriptRoot/../docs" Accept pipeline input? false Accept wildcard characters? false [] This script supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. ``` Example ------- ```powershell 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/docs ... ✔️ Exported 518 Markdown manuals in 28 sec. ``` Notes ----- Author: Markus Fleschutz | License: CC0 Related Links ------------- https://github.com/fleschutz/PowerShell Script Content -------------- ```powershell <# .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/docs ... ✔️ Exported 518 Markdown manuals 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() "⏳ (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 "✔️ Exported $($scripts.Count) Markdown manuals in $elapsed sec." exit 0 # success } catch { "⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])" exit 1 } ``` *(generated by convert-ps2md.ps1 using the comment-based help of export-to-manuals.ps1 as of 08/15/2024 09:50:47)*