public/Add-HelpDocText.ps1
|
<# .SYNOPSIS Return a markdown formatted text. .DESCRIPTION Return the given string optionally formatted as a Header. .PARAMETER HelpDoc A HelpDoc object. .PARAMETER Text A string to add to the HelpDoc. .PARAMETER H1 Format the text as an H1 header. .PARAMETER H2 Format the text as an H2 header. .PARAMETER H3 Format the text as an H3 header. .NOTES If no Header switch is provided, the default is no formatting. .LINK New-HelpDoc .LINK Get-HelpModuleData .EXAMPLE Get-HelpModuleData build-docs | New-HelpDoc | Add-HelpDocText -Text "My Module Help" -H1 | Out-HelpDoc # My Module Help Add a level 1 header with the text "My Module Help". #> function Add-HelpDocText { [CmdletBinding(DefaultParameterSetName = "NoH")] param ( [Parameter(Mandatory, Position = 1, ValueFromPipeline, ParameterSetName = "NoH")] [Parameter(Mandatory, Position = 1, ValueFromPipeline, ParameterSetName = "H1")] [Parameter(Mandatory, Position = 1, ValueFromPipeline, ParameterSetName = "H2")] [Parameter(Mandatory, Position = 1, ValueFromPipeline, ParameterSetName = "H3")] [PSCustomObject] $HelpDoc, [Parameter(Mandatory, Position = 0, ParameterSetName = "NoH")] [Parameter(Mandatory, Position = 0, ParameterSetName = "H1")] [Parameter(Mandatory, Position = 0, ParameterSetName = "H2")] [Parameter(Mandatory, Position = 0, ParameterSetName = "H3")] [string] $Text, [Parameter(ParameterSetName = "H1")] [Switch] $H1, [Parameter(ParameterSetName = "H2")] [Switch] $H2, [Parameter(ParameterSetName = "H3")] [Switch] $H3 ) begin { } process { $heading = [string]::Empty switch ($true) { $H1 { $heading = '# ' } $H2 { $heading = '## ' } $H3 { $heading = '### ' } Default {} } $HelpDoc.Text += '{0}{1}{2}{2}' -f $heading, $Text, [System.Environment]::NewLine $HelpDoc | Write-Output } end { } } |