Skip to content

Latest commit

 

History

History
25 lines (15 loc) · 613 Bytes

Out-HelpDoc.md

File metadata and controls

25 lines (15 loc) · 613 Bytes
Raw

Out-HelpDoc

Output the Markdown formatted HelpDoc and optionally write to the provide file path.

Parameters

Parameter Set 1

  • [PSObject] HelpDoc A HelpDoc object with a populated Text property. Mandatory, ValueFromPipeline
  • [String] Path Write the output to a .md file.

Examples

Example 1

Get the help data for the build-docs module, add an H1 header of the module name, then output the Markdown.

Get-HelpModuleData build-docs | New-HelpDoc | Add-ModuleProperty -Property Name -H1 | Out-HelpDoc
# build-docs

Links