Member-only story
Hands-on Tutorial: Building Stunning Websites from PowerShell YAML Data with Microsoft.PowerShell.PlatyPS
With the new improved Microsoft.PowerShell.PlatyPS
PowerShell module, you can easily create YAML files representing your help files for the functions or commands you are exposing.
While YAML is easy to read, creating the ability to render it to HTML and display it on a website brings another dimension to your documentation.
In this hands-on tutorial, you will learn:
- What is YAML?
- Create YAML files using
Microsoft.PowerShell.PlatyPS
- Generate HTML files with
yst
Let's go through the prerequisites before we get into the guide.
Prerequisites
- A Windows machine running PowerShell 7.4+
- Chocolatey
- Microsoft.PowerShell.PlatyPs v1.0.0-preview1 installed
What is YAML?
Before you produce YAML files, it is important to understand YAML. YAML stands for YAML Ain’t Markup Language. Many prefer it over JSON due to its readability over JSON.
Frequently used for configuration files and data exchange, YAML’s original purpose has expanded in the PowerShell world. Here…