*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/Scripts/../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/Scripts/../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/06/2023 11:42:27)*