{"repo":"PowerShell/platyPS","free":true,"listed":false,"github":"https://github.com/PowerShell/platyPS","clone":"git clone https://github.com/PowerShell/platyPS.git","description":"Write PowerShell External Help in Markdown","language":"C#","stars":872,"topics":["powershell"],"license":"MIT","category":"cli-tools","readme_excerpt":"Microsoft.PowerShell.PlatyPS PlatyPS is the tool that Microsoft uses to create the PowerShell content you get from Get-Help and build the content published as [PowerShell documentation][03] on Microsoft Learn. PowerShell help files are stored as [Microsoft Assistance Markup Language][05] (MAML), an XML format. PlatyPS simplifies the authoring process by allowing you to write the help files in Markdown, then convert to MAML. [Markdown][04] is widely used in the software industry, supported by many editors including Visual Studio Code , and easier to author. Microsoft.PowerShell.PlatyPS includes several improvements: - Re-write in C# leveraging [markdig][02] for parsing Markdown (the same library used by Microsoft Learn to render Markdown) - Provides a more accurate description of a PowerShell cmdlet and its parameters and includes information that was previously unavailable - Creates an object model of the help file that you can manipulate and supports chaining cmdlets for complex operations - Increased performance - processes 1000s of Markdown files in seconds Install Microsoft.PowerShell.PlatyPS PlatyPS runs on: - Windows PowerShell 5.1+ - PowerShell 7+ on Windows, Linux, and macOS Install the module from [PSGallery][06]. Getting started using PlatyPS Creating help files with PlatyPS is a multi-step process: 1. [ Create new ][09] or [ update existing ][10] Markdown help files 2. [ Edit the Markdown help ][11] to add descriptions and examples 3. [ Test the Markdown help ][12]","default_branch":null,"files":null,"tree":[],"storefront":"/r/PowerShell","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/PowerShell/platyPS/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}