Behind the PowerShell Pipeline logo

Behind the PowerShell Pipeline

Subscribe
Archives
October 26, 2023

More Platyps Power

Last time, I demonstrated how to use the Platyps module from Microsoft to create external help for your PowerShell commands. The concept is to create a markdown document, which can then be exported to the usual MAML-based XML format PowerShell uses for help documentation. I showed you how to use a few module commands to create external help for a stand-alone function. As you’ll see, the process isn’t very different when we get to modules.

In the previous demonstrations, I created new markdown documents and showed you how to update them. But let’s say you revise the command, such as adding a parameter. You don’t want to have to recreate the markdown document. Here’s how you can save some time.

Update-MarkdownHelp

One of the functions I showed last time created a brief system status. It may not have been clear in my demos, but the function creates a property for each logical disk.

Want to read the full issue?
GitHub Bluesky LinkedIn About Jeff
Powered by Buttondown, the easiest way to start and grow your newsletter.