PlatyPS: PowerShell Help meets Markdown
summary
PlatyPS converts Markdown into MAML XML so you can write one source and produce both web pages and PowerShell external help; commands like new-markdown-help and new-external-help generate markdown and XML, and PlatyPS includes get-help-preview, bootstrapping for whole modules (a large module converts in ~30 seconds in the demo), CI checks that fail when docs are out of date by inspecting git diffs, link checking and spellcheck, and it works end-to-end with one caveat: default parameter values do not reliably round-trip.
AI-written summary · about
chapters (15)
- 0:00Introduction
- 1:00PowerShell Help
- 3:03MAME XML
- 6:22Websites
- 8:42My personal experience
- 14:21What is PlatyPS
- 17:56Demo
- 22:01Get Help Preview
- 27:33Markdown
- 29:49Markdown for Help
- 30:48Markdown Helper Functions
- 39:33Markdown bootstrap
- 42:26Markdown Schema
- 51:29Life cycle
- 52:40Adding a parameter
related talks
01h 21mPublish PowerShell help content using PlatyPS v1.0
01h 29mWhat's new in PlatyPS
41mI like good Docs, and I cannot lie
35mSwitching from Sphinx to Markdown
45mGitHub Actions for Fun and Profit
32mSwitching from Sphinx to Markdown
45mPowerShell Module Mass Production: Templating in the Field
01h 14mCreating a PowerShell Editor