48 lines (30 loc) · 1.27 KB

Add-HelpDocText

Return the given string optionally formatted as a Header.

Parameters

Parameter Set 1

[PSObject] HelpDoc A HelpDoc object. Mandatory, ValueFromPipeline
[String] Text A string to add to the HelpDoc. Mandatory

Parameter Set 2

[PSObject] HelpDoc A HelpDoc object. Mandatory, ValueFromPipeline
[String] Text A string to add to the HelpDoc. Mandatory
[Switch] H3 Format the text as an H3 header.

Parameter Set 3

[PSObject] HelpDoc A HelpDoc object. Mandatory, ValueFromPipeline
[String] Text A string to add to the HelpDoc. Mandatory
[Switch] H2 Format the text as an H2 header.

Parameter Set 4

[PSObject] HelpDoc A HelpDoc object. Mandatory, ValueFromPipeline
[String] Text A string to add to the HelpDoc. Mandatory
[Switch] H1 Format the text as an H1 header.

Examples

Example 1

Add a level 1 header with the text "My Module Help".

Get-HelpModuleData build-docs | New-HelpDoc | Add-HelpDocText -Text "My Module Help" -H1 | Out-HelpDoc
# My Module Help

Links

Notes

If no Header switch is provided, the default is no formatting.