platyPS

The platyPS module allows you to create PowerShell External Help in Markdown.

Note

Support for the module is limited. Please file issues in the source repository using the This product button in the Feedback section at the bottom of the page.

platyPS

Get-HelpPreview

Displays your generated external help as Get-Help output.

Get-MarkdownMetadata

Gets metadata from the header of a markdown file.

Merge-MarkdownHelp

Merge multiple markdown versions of the same cmdlet into a single markdown file.

New-ExternalHelp

Creates external help file based on markdown supported by PlatyPS.

New-ExternalHelpCab

Generates a .cab file.

New-MarkdownAboutHelp

Generates a new About Topic MD file from template.

New-MarkdownHelp

Creates help in markdown format.

New-YamlHelp

Converts Markdown help into YAML to be read easily by external tools

Update-MarkdownHelp

Update PlatyPS markdown help files.

Update-MarkdownHelpModule

Update all files in a markdown help module folder.