Quick Start

Quick start

• Install platyPS module from the PowerShell Gallery:

Install-Module -Name platyPS -Scope CurrentUser
Import-Module platyPS

• Create initial Markdown help for MyAwesomeModule module:

# you should have module imported in the session
Import-Module MyAwesomeModule
New-MarkdownHelp -Module MyAwesomeModule -OutputFolder .\docs

• Edit markdown files in .\docs folder and populate {{ ... }} placeholders with missed help content.

• Create external help from markdown help

New-ExternalHelp .\docs -OutputPath en-US\

• Congratulations, your help is now in markdown!

• Now, if your module code changes, you can easily update your markdown help with

# re-import your module with latest changes
Import-Module MyAwesomeModule -Force
Update-MarkdownHelp .\docs