Edit

Share via


Microsoft.PowerShell.PlatyPS

This module contains cmdlets to help with the creation help content for PowerShell commands.

Microsoft.PowerShell.PlatyPS

Compare-CommandHelp

Compares two CommandHelp objects and produces a detailed report showing the differences.

Export-MamlCommandHelp

Exports CommandHelp objects to a MAML file.

Export-MarkdownCommandHelp

Exports a CommandHelp object to a markdown file.

Export-MarkdownModuleFile

Exports a ModuleFileInfo object to a markdown file.

Export-YamlCommandHelp

Exports CommandHelp objects to YAML files.

Export-YamlModuleFile

Exports a ModuleFileInfo object to a Yaml file.

Import-MamlHelp

Imports MAML help from a file and creates CommandHelp objects for each command in the file.

Import-MarkdownCommandHelp

Imports Markdown help content into CommandHelp objects.

Import-MarkdownModuleFile

Imports a Markdown module file into a ModuleHelp object.

Import-YamlCommandHelp

Imports Yaml help content into CommandHelp objects.

Import-YamlModuleFile

Imports a Yaml module file into a ModuleHelp object.

Measure-PlatyPSMarkdown

Determines the type of Markdown file.

New-CommandHelp

Creates CommandHelp objects for a PowerShell command that's loaded in the session.

New-HelpCabinetFile

Creates a help cabinet file for a module that can be published as updateable help content.

New-MarkdownCommandHelp

Creates Markdown help files for PowerShell modules and commands.

New-MarkdownModuleFile

Creates the Markdown module file for a PowerShell module.

Show-HelpPreview

View MAML file contents as it would appear when output by Get-Help.

Test-MarkdownCommandHelp

Tests the structure of a Markdown help file.

Update-CommandHelp

Updates an imported CommandHelp object with the information from session cmdlet of the same name.

Update-MarkdownCommandHelp

Updates an imported Markdown command file with the information from session cmdlet of the same name.

Update-MarkdownModuleFile

Updates the Markdown module file.