{"id":20849,"date":"2025-07-24T13:35:14","date_gmt":"2025-07-24T21:35:14","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/powershell\/?p=20849"},"modified":"2025-07-24T13:35:14","modified_gmt":"2025-07-24T21:35:14","slug":"announcing-platyps-100","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/powershell\/announcing-platyps-100\/","title":{"rendered":"Announcing Microsoft.PowerShell.PlatyPS 1.0.0"},"content":{"rendered":"<p><!-- markdownlint-disable MD041 --><\/p>\n<p>We&#8217;re pleased to announce the general availability (GA) release of\n<a href=\"https:\/\/www.powershellgallery.com\/packages\/Microsoft.PowerShell.PlatyPS\">Microsoft.PowerShell.PlatyPS v1.0.0<\/a>.<\/p>\n<p><strong>PlatyPS<\/strong> is the tool that Microsoft uses to create the PowerShell content you get from <code>Get-Help<\/code>\nand build the content published as <a href=\"https:\/\/learn.microsoft.com\/powershell\/scripting\">PowerShell documentation<\/a> on Microsoft Learn.<\/p>\n<p>PowerShell help files are stored as <a href=\"https:\/\/wikipedia.org\/wiki\/Microsoft_Assistance_Markup_Language\">Microsoft Assistance Markup Language<\/a> (MAML), an XML\nformat. <strong>PlatyPS<\/strong> simplifies the authoring process by allowing you to write the help files in\nMarkdown, then convert to MAML. <a href=\"https:\/\/wikipedia.org\/wiki\/Markdown\">Markdown<\/a> is widely used in the software industry,\nsupported by many editors including <strong>Visual Studio Code<\/strong>, and easier to author.<\/p>\n<p>With this release, <strong>Microsoft.PowerShell.PlatyPS<\/strong> is the supported tool. This release is a\nsubstantial rewrite with all new cmdlets. <strong>platyPS v0.14.2<\/strong> is no longer supported. We encourage\nall users to upgrade to <strong>Microsoft.PowerShell.PlatyPS<\/strong> for the latest features, performance\nimprovements, and ongoing support. If you have scripts that use the older version of <strong>platyPS<\/strong>,\nyou must rewrite them to use the new cmdlets.<\/p>\n<p><strong>Microsoft.PowerShell.PlatyPS<\/strong> includes several improvements:<\/p>\n<ul>\n<li>Re-write in C# leveraging <a href=\"https:\/\/github.com\/xoofx\/markdig\">markdig<\/a> for parsing Markdown (the same library used by\nMicrosoft Learn to render Markdown)<\/li>\n<li>Provides a more accurate description of a PowerShell cmdlet and its parameters and includes\ninformation that was previously unavailable<\/li>\n<li>Creates an object model of the help file that you can manipulate and supports chaining cmdlets for\ncomplex operations<\/li>\n<li>Increased performance &#8211; processes 1000s of Markdown files in seconds<\/li>\n<\/ul>\n<p><strong>Microsoft.PowerShell.PlatyPS<\/strong> runs on:<\/p>\n<ul>\n<li>Windows PowerShell 5.1+<\/li>\n<li>PowerShell 7+ on Windows, Linux, and macOS<\/li>\n<\/ul>\n<h2>Installing Microsoft.PowerShell.PlatyPS<\/h2>\n<p>To begin working with <strong>Microsoft.PowerShell.PlatyPS 1.0.0<\/strong>, install the module from PSGallery.<\/p>\n<pre><code class=\"language-powershell\">Install-PSResource -Name Microsoft.PowerShell.PlatyPS<\/code><\/pre>\n<h2>Documentation to get started<\/h2>\n<p>For this release, the cmdlet reference is available at <a href=\"https:\/\/learn.microsoft.com\/powershell\/module\/microsoft.powershell.platyps\">Microsoft.PowerShell.PlatyPS<\/a>.\nFor an example of how to use the new cmdlets, see <em>Example #1<\/em> in <a href=\"https:\/\/learn.microsoft.com\/powershell\/module\/microsoft.powershell.platyps\/new-markdowncommandhelp#example-1-create-markdown-help-files-for-a-module\">New-MarkdownCommandHelp<\/a>.<\/p>\n<h2>Call to action<\/h2>\n<p>Our goal is to make it easier for you to update and maintain PowerShell help files. We value your\nfeedback. Stop by our <a href=\"https:\/\/github.com\/PowerShell\/platyPS\">GitHub repository<\/a> and let us know of any issues you find.<\/p>\n<p>Interested in contributing to the PlatyPS project? We welcome feature ideas and contributions.\nPlease follow the contribution guidance in the <a href=\"https:\/\/github.com\/PowerShell\/platyPS\/blob\/main\/README.md\">Github Readme<\/a>.<\/p>\n<p>Jason Helmick<\/p>\n<p>Sr. Product Manager, PowerShell<\/p>\n<p><!-- link references --><\/p>\n","protected":false},"excerpt":{"rendered":"<p>We are pleased to announce the general availability of Microsoft.PowerShell.PlatyPS 1.0.0, a tool to build PowerShell help files.<\/p>\n","protected":false},"author":7527,"featured_media":13641,"comment_status":"open","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[1],"tags":[3172],"class_list":["post-20849","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-powershell","tag-powershell-platyps"],"acf":[],"blog_post_summary":"<p>We are pleased to announce the general availability of Microsoft.PowerShell.PlatyPS 1.0.0, a tool to build PowerShell help files.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts\/20849","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/users\/7527"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/comments?post=20849"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/posts\/20849\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/media\/13641"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/media?parent=20849"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/categories?post=20849"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/powershell\/wp-json\/wp\/v2\/tags?post=20849"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}