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

Update convert-ps2md.ps1

Browse Source
This commit is contained in:
Markus Fleschutz 2021-08-28 17:48:14 +02:00
parent 6deaa2fbe7
commit 69088aa489
1 changed files with 26 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

61
Scripts/convert-ps2md.ps1
View File

@ -14,19 +14,11 @@
param([string]$script = "") param([string]$script = "")
function EncodePartOfHtml { function EncodePartOfHtml { param([string]$Value)
param (
[string]
$Value
)
($Value -replace '<', '&lt;') -replace '>', '&gt;' ($Value -replace '<', '&lt;') -replace '>', '&gt;'
} }
function GetCode { function GetCode { param($Example)
param (
$Example
)
$codeAndRemarks = (($Example | Out-String) -replace ($Example.title), '').Trim() -split "`r`n" $codeAndRemarks = (($Example | Out-String) -replace ($Example.title), '').Trim() -split "`r`n"
$code = New-Object "System.Collections.Generic.List[string]" $code = New-Object "System.Collections.Generic.List[string]"
@ -43,10 +35,7 @@ function GetCode {
$code -join "`r`n" $code -join "`r`n"
} }
function GetRemark { function GetRemark { param($Example)
param (
$Example
)
$codeAndRemarks = (($Example | Out-String) -replace ($Example.title), '').Trim() -split "`r`n" $codeAndRemarks = (($Example | Out-String) -replace ($Example.title), '').Trim() -split "`r`n"
$isSkipped = $false $isSkipped = $false
@ -65,12 +54,18 @@ function GetRemark {
try { try {
if ($script -eq "") { $script = read-host "Enter path to PowerShell script" } if ($script -eq "") { $script = read-host "Enter path to PowerShell script" }
$full = Get-Help $script -Full $full = Get-Help $script -Full -Path D:
"# $($full.Synopsis)" "# PowerShell Script $script"
""
"## Synopsis"
"$($full.Synopsis)"
$Description = ($full.description | Out-String).Trim() $Description = ($full.description | Out-String).Trim()
if ($Description -ne "") { if ($Description -ne "") {
""
"## Description"
"$Description" "$Description"
} }
@ -85,40 +80,36 @@ try {
foreach($parameter in $full.parameters.parameter) { foreach($parameter in $full.parameters.parameter) {
"" ""
"## Parameter -$($parameter.name) &lt;$($parameter.type.name)&gt;" "## -$($parameter.name) &lt;$($parameter.type.name)&gt; Parameter"
"$(($parameter.description | Out-String).Trim())" "$(($parameter.description | Out-String).Trim())"
"``````" "``````"
"$(((($parameter | Out-String).Trim() -split "`r`n")[-5..-1] | % { $_.Trim() }) -join "`r`n")" "$(((($parameter | Out-String).Trim() -split "`r`n")[-5..-1] | % { $_.Trim() }) -join "`r`n")"
"``````" "``````"
} }
"## <CommonParameters>"
"This cmdlet supports the common parameters: Verbose, Debug, ErrorAction, ErrorVariable, WarningAction, WarningVariable, OutBuffer, PipelineVariable, and OutVariable. For more information, see about_CommonParameters (https://go.microsoft.com/fwlink/?LinkID=113216)."
foreach($input in $full.inputTypes) { foreach($input in $full.inputTypes.inputType) {
"" ""
"## Inputs" "## Inputs"
"$($input.inputType.type.name)" "$($input.type.name)"
} }
foreach($output in $full.outputTypes) { foreach($output in $full.outputTypes.outputType) {
"" ""
"## Outputs" "## Outputs"
"$($output.outputType.type.name)" "$($output.type.name)"
} }
@"
## Examples foreach($example in $full.examples.example) {
"@ + $(foreach ($example in $full.examples.example) { ""
@" "## Example"
"``````powershell"
"$(GetCode $example)"
"``````"
"$(GetRemark $example)"
}
### $(($example.title -replace '-*', '').Trim())
``````powershell
$(GetCode $example)
``````
$(GetRemark $example)
"@
}) + @"
"@
$Notes = ($full.alertSet.alert | Out-String).Trim() $Notes = ($full.alertSet.alert | Out-String).Trim()
if ($Notes -ne "") { if ($Notes -ne "") {
"" ""