Asserting Microsoft.PowerShell.PlatyPS 1.0.0-Preview1 – PowerShell Workforce

PlatyPS is the first software for creating the PowerShell assist displayed utilizing Get-Assist.
PowerShell assist information are saved in an XML format referred to as
Microsoft Help Markup Language (MAML). Previous to PlatyPS, the assistance information have been hand
authored utilizing complicated software chains. Markdown is extensively used within the open supply neighborhood,
supported by many editors together with Visible Studio Code, and simpler to writer. PlatyPS
simplifies the method by permitting you to write down the assistance information in Markdown after which transformed to
MAML.

Asserting Microsoft.PowerShell.PlatyPS

We’re happy to announce the discharge of Microsoft.PowerShell.PlatyPS 1.0.0-Preview1. With
this launch, there are two variations of PlatyPS.

• platyPS v0.14.2 is the present model of PlatyPS that’s used to create PowerShell assist information
  in Markdown format.
• Microsoft.PowerShell.PlatyPS is the brand new model of PlatyPS that features a number of enhancements:
  • Gives a extra correct description of a PowerShell cmdlet and its parameters
  • Elevated efficiency – processes 1000s of Markdown information in seconds
  • Creates an object mannequin of the assistance file that you could manipulate in reminiscence
  • Gives cmdlets that you could chain collectively to carry out complicated operations

Our fundamental aim for this launch is to deal with lengthy standing points, add extra schema pushed
options, and enhance validity checking together with efficiency. This launch is a considerable
rewrite with all new cmdlets. When you’ve got scripts that use the older model of PlatyPS, you have to
rewrite them to make use of the brand new cmdlets.

On this Preview launch, we centered on:

• Re-write in C# leveraging markdig for parsing Markdown.
• New Markdown schema that features all components wanted for Get-Assist, plus info that was
  beforehand unavailable.
• The brand new cmdlets produce objects, supporting chaining cmdlets for complicated operations.
• Full serialization to YAML to assist our publishing pipeline.
• Computerized conversion of current Markdown to the brand new object mannequin.
• Export of the item mannequin to Markdown, Yaml, and MAML.
• The module accommodates the next cmdlets:
  • Evaluate-CommandHelp
  • Export-MamlCommandHelp
  • Export-MarkdownCommandHelp
  • Export-MarkdownModuleFile
  • Export-YamlCommandHelp
  • Export-YamlModuleFile
  • Import-MamlHelp
  • Import-MarkdownCommandHelp
  • Import-MarkdownModuleFile
  • Import-YamlCommandHelp
  • Import-YamlModuleFile
  • New-CommandHelp
  • New-MarkdownCommandHelp
  • New-UpdateableHelp
  • Check-MarkdownCommandHelp
  • Replace-CommandHelp
  • Replace-MarkdownCommandHelp

Microsoft.PowerShell.PlatyPS runs on:

• Home windows PowerShell 5.1+
• PowerShell 7+ on Home windows, Linux, and macOS

Putting in Microsoft.PowerShell.PlatyPS

To start working with Microsoft.PowerShell.PlatyPS 1.0.0 Preview1, obtain and set up the
module from PSGallery.

Set up-PSResource -Title Microsoft.PowerShell.PlatyPS -Prerelease

Documentation to get began

For the preview1 launch, the cmdlet reference is on the market at Microsoft.PowerShell.PlatyPS.
For an instance of how you can use the brand new cmdlets, see Instance #1 in New-MarkdownCommandHelp.

Name to motion

Our aim is to make it simpler so that you can replace and preserve PowerShell assist information. We worth your
suggestions. Cease by our GitHub repository and tell us of any points you discover.

Jason Helmick

Sr. Product Supervisor, PowerShell