PlatyPS is an open-source PowerShell tool for writing help in readable Markdown, then generating external MAML documentation. Markdown remains an independently editable source that works well with GitHub and ordinary text editors. section 14.5 section 18.8
Use PlatyPS to reduce documentation maintenance:
- Generate Markdown stubs from code, including discoverable parameter details such as mandatory status and pipeline input. section 14.5
- Update existing help stubs when parameters are added or changed, then complete the new explanatory content. section 14.5
- Produce valid MAML for PowerShell help systems, while allowing other tools to generate web-based HTML from Markdown. section 14.5
A maintainable help workflow
Start with PowerShell code, generate a Markdown framework, fill in descriptions and examples, and regenerate outputs when the code changes. This keeps external help separate from implementation and avoids repeatedly constructing MAML by hand. section 14.5
