platyPS
A PowerShell module for authoring external help files in Markdown and converting them to MAML format.
What is platyPS?
PlatyPS is a PowerShell module developed by Microsoft that simplifies the creation of PowerShell help content. It allows authors to write documentation in Markdown, a widely supported and easier-to-use format, and converts it to the Microsoft Assistance Markup Language (MAML) XML format used by PowerShell's `Get-Help` command and Microsoft Learn documentation.
PowerShell module developers and technical writers who need to create or maintain help documentation for PowerShell cmdlets, especially those contributing to Microsoft's official PowerShell documentation on Microsoft Learn.
Developers choose PlatyPS because it replaces complex XML authoring with Markdown, leveraging industry-standard tools like Visual Studio Code, and provides high-performance processing with accurate cmdlet representation through a C# rewrite using the Markdig library.
Overview
Write PowerShell External Help in Markdown
Use Cases
Best For
- Creating PowerShell help files for custom modules without dealing with MAML XML directly.
Related Projects
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.
