PlatyPS
PlatyPS
Your guide to PowerShell documentation
About the Book
In February 2016, the first version of PlatyPS was released to the public. Since then, it has become one of the most beloved modules for generating PowerShell documentation. The documentation you see in many open-source projects and content around PowerShell on Microsoft Learn, is created using this module.
At the beginning of 2024, Jason Helmick announced upcoming changes to the module during the PowerShell community call, hinting at a completely re-branded module. This was confirmed with the first preview release in October 2024. James Truher gave an excellent demo during PSConfEU 2024 Minicon, showcasing the module's capabilities and the underlying codebase changes. While PlatyPS was a fully script-based module, the newly branded module, Microsoft.PowerShell.PlatyPS, is written in C#.
Even though PlatyPS has many guidelines circulating among communities and experts, the preview launch inspired me to compile everything from these guidelines and include the new commands in a single book.
This book is divided into five chapters and includes many exercises in each chapter:
- Getting started with Microsoft.PowerShell.PlatyPS module
- Creating help content
- Importing and exporting help content
- Update and maintaining help content
- Real word examples and use cases
All of the code content will be available for download in ZIP format.
Feedback
You can simply use the "Email the Author(s)" link if you have any feedback. I'm always open for feedback. Was something unclear or not right? Or do you feel complementary? Let me know, all are welcome!
About the Author
Table of Contents
- Foreword
- About this book
- Who is this book for?
- Code listings and typographic conventions
- What you need for this book
- Feedback
- Coding samples
- Lab environment
- About the author
- Chapter 1 - Getting Started with Microsoft.PowerShell.PlatyPS
- History and development
- Installing Microsoft.PowerShell.PlatyPS
- Discovering commands
- Creating your first help file
- Summary
- Chapter 2 - Creating help content
- Deep dive in CommandHelp objects
- Arbitrary front matter data
- Exploring New-MarkdownCommandHelp command
- Creating module file with New-MarkdownModuleFile
- Summary
- Chapter 3 - Importing and exporting help content
- Microsoft.PowerShell.PlatyPS schema version analysis
- Comparing help content
- How to import help content in various formats
- Export MAML, YAML and Markdown
- Techniques for migrating older documentation
- Summary
- Chapter 4 - Updating and maintaining help content
- How to update CommandHelp object with Update-CommandHelp
- Updating Markdown help files
- Guidelines for maintaining help files
- Summary
- Chapter 5 - Real world examples and use cases
- Common scenarios and solutions
- Release notes
The Leanpub 60 Day 100% Happiness Guarantee
Within 60 days of purchase you can get a 100% refund on any Leanpub purchase, in two clicks.
Now, this is technically risky for us, since you'll have the book or course files either way. But we're so confident in our products and services, and in our authors and readers, that we're happy to offer a full money back guarantee for everything we sell.
You can only find out how good something is by trying it, and because of our 100% money back guarantee there's literally no risk to do so!
So, there's no reason not to click the Add to Cart button, is there?
See full terms...
Earn $8 on a $10 Purchase, and $16 on a $20 Purchase
We pay 80% royalties on purchases of $7.99 or more, and 80% royalties minus a 50 cent flat fee on purchases between $0.99 and $7.98. You earn $8 on a $10 sale, and $16 on a $20 sale. So, if we sell 5000 non-refunded copies of your book for $20, you'll earn $80,000.
(Yes, some authors have already earned much more than that on Leanpub.)
In fact, authors have earnedover $14 millionwriting, publishing and selling on Leanpub.
Learn more about writing on Leanpub
Free Updates. DRM Free.
If you buy a Leanpub book, you get free updates for as long as the author updates the book! Many authors use Leanpub to publish their books in-progress, while they are writing them. All readers get free updates, regardless of when they bought the book or how much they paid (including free).
Most Leanpub books are available in PDF (for computers) and EPUB (for phones, tablets and Kindle). The formats that a book includes are shown at the top right corner of this page.
Finally, Leanpub books don't have any DRM copy-protection nonsense, so you can easily read them on any supported device.
Learn more about Leanpub's ebook formats and where to read them
