extern/PowerShell
1
0
Fork 0
mirror of https://github.com/fleschutz/PowerShell.git synced 2025-04-03 05:31:03 +02:00
Code Issues Packages Projects Releases Wiki Activity

Updated convert-ps2md.ps1 and export-to-manuals.ps1

Browse Source
This commit is contained in:
Markus Fleschutz 2024-01-25 13:36:21 +01:00
parent 46a49b5291
commit e12bff48a1
2 changed files with 14 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
scripts/convert-ps2md.ps1
View File

@ -52,12 +52,12 @@ function GetRemark { param($Example)
try { try {
if ($filename -eq "") { $filename = Read-Host "Enter path to PowerShell script" } if ($filename -eq "") { $filename = Read-Host "Enter path to PowerShell script" }
$ScriptName = (Get-Item "$filename").Name
$ScriptName = (Get-Item "$filename").Name
$full = Get-Help $filename -Full $full = Get-Help $filename -Full
"*$($ScriptName)*" "Script: *$($ScriptName)*"
"================" "========================"
$Description = ($full.description | Out-String).Trim() $Description = ($full.description | Out-String).Trim()
if ($Description -ne "") { if ($Description -ne "") {

22
scripts/export-to-manuals.ps1
View File

@ -2,12 +2,12 @@
.SYNOPSIS .SYNOPSIS
Exports all scripts as manuals Exports all scripts as manuals
.DESCRIPTION .DESCRIPTION
This PowerShell script exports the comment based help of all PowerShell scripts as manuals. This PowerShell script exports the comment-based help of all PowerShell scripts as manuals.
.EXAMPLE .EXAMPLE
PS> ./export-to-manuals.ps1 PS> ./export-to-manuals.ps1
⏳ (1/2) Reading PowerShell scripts from /home/mf/PowerShell/scripts/*.ps1 ... ⏳ (1/2) Reading PowerShell scripts from /home/mf/PowerShell/scripts/*.ps1 ...
⏳ (2/2) Exporting Markdown manuals to /home/mf/PowerShell/docs ... ⏳ (2/2) Exporting Markdown manuals to /home/mf/PowerShell/docs ...
✔️ Exported 518 Markdown manuals in 28 sec ✔️ Exported 518 Markdown manuals in 28 sec.
.LINK .LINK
https://github.com/fleschutz/PowerShell https://github.com/fleschutz/PowerShell
.NOTES .NOTES
@ -16,21 +16,21 @@
#requires -version 2 #requires -version 2
param([string]$FilePattern = "$PSScriptRoot/*.ps1", [string]$TargetDir = "$PSScriptRoot/../docs") param([string]$filePattern = "$PSScriptRoot/*.ps1", [string]$targetDir = "$PSScriptRoot/../docs")
try { try {
$StopWatch = [system.diagnostics.stopwatch]::startNew() $stopWatch = [system.diagnostics.stopwatch]::startNew()
"⏳ (1/2) Reading PowerShell scripts from $FilePattern ..." "⏳ (1/2) Reading PowerShell scripts from $filePattern ..."
$Scripts = Get-ChildItem "$FilePattern" $scripts = Get-ChildItem "$filePattern"
"⏳ (2/2) Exporting Markdown manuals to $TargetDir ..." "⏳ (2/2) Exporting Markdown manuals to $targetDir ..."
foreach ($Script in $Scripts) { foreach ($script in $scripts) {
& "$PSScriptRoot/convert-ps2md.ps1" "$Script" > "$TargetDir/$($Script.BaseName).md" & "$PSScriptRoot/convert-ps2md.ps1" "$script" > "$targetDir/$($script.BaseName).md"
} }
[int]$Elapsed = $StopWatch.Elapsed.TotalSeconds [int]$elapsed = $stopWatch.Elapsed.TotalSeconds
"✔️ Exported $($Scripts.Count) Markdown manuals in $Elapsed sec" "✔️ Exported $($scripts.Count) Markdown manuals in $elapsed sec."
exit 0 # success exit 0 # success
} catch { } catch {
"⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])" "⚠️ Error in line $($_.InvocationInfo.ScriptLineNumber): $($Error[0])"