- Category
- Developer Tools
- Rank
- No. 764Tools index
Previous survey · No. 747 ·
- Pricing
- Open Source
- Type
- TOOL
- Builder
- powershell
- GitHub
- 872 stars
- Latest release
- v1.0.3
- Date
About
Author PowerShell external help in Markdown. Lets module authors write friendlier docs that compile to the MAML help format.
What it does
PlatyPS inspects PowerShell command metadata, builds a manipulable help object, and inserts placeholders for material requiring human judgment. Authors can update that object through pipeline operations, preserve written content while refreshing discovered metadata, and export the result as Markdown, YAML, or MAML.
Why it's ranked here
This is a credible choice for serious PowerShell documentation pipelines. Microsoft uses it for console help and published PowerShell documentation. Its structured object model, metadata discovery, format conversion, pipeline chaining, and stated ability to process thousands of Markdown files in seconds give it practical depth beyond a simple converter.
What's good
It gathers parameter sets, types, attributes, common parameters, and declared input and output types from available commands. Updates retain authored descriptions and formatting while adding newly discovered facts. Markdown and YAML preserve the complete object model, and diagnostics help authors find structural or metadata problems. The current implementation uses the same Markdown parser cited for Microsoft Learn.
Tradeoffs
Human editing remains mandatory because the tool cannot supply descriptions, examples, notes, or related links. Validation covers basic document structure and required metadata, not whether prose or command facts are accurate. Updating requires the relevant commands or modules in the current session. Migration from the old Markdown schema is one-way, and MAML conversion loses information because that format cannot represent the full model.
How to use it well
Use it when a PowerShell module team wants Markdown as the maintained documentation source, especially for large, binary, closed-source, or separately documented modules. Generate or import the initial structure, write the explanatory material, test rendering, refresh metadata when commands change, review every update, then publish converted help. It does not replace technical writing, factual review, or general-purpose documentation publishing.
Technical notes+
README.md describes the current C# rewrite, Markdig parsing, the PowerShell Gallery installation surface, and the supported runtime platforms. docs/PlatyPS-Design-Notes.md defines CommandHelp as the central object model and documents Markdown, YAML, and MAML import and export behavior, including one-way legacy-schema migration and MAML fidelity loss. build.ps1 builds src/Microsoft.PowerShell.PlatyPS.csproj, assembles the module with Markdig.Signed.dll and YamlDotNet.dll, runs test/Pester through Pester 4.x, and can publish a NuGet package. global.json selects .NET SDK 10.0.109 with latest-major roll-forward, while README.md lists .NET 8 SDK as a build prerequisite.
Observed
- License
- MIT License
- Primary language
- C# implementation wrapped as a PowerShell module
- Installation
- Distributed through PowerShell Gallery as Microsoft.PowerShell.PlatyPS and installed with Install-PSResource
- Interface
- PowerShell cmdlets that support pipeline chaining and manipulate a help object model
- Platform support
- Windows PowerShell 5.1+, plus PowerShell 7+ on Windows, Linux, and macOS
- Repository structure
- Source, design documentation, build tools, and a test directory with Pester tests
Read from README.md, docs/README.md, docs/PlatyPS-Design-Notes.md, docs/archive/Schema-Notes.md, docs/archive/alias-prototype.md, docs/archive/platyps_2.0_update.md, docs/archive/platyps_2.0_cmdlets.md, docs/archive/platyps_2.0_about_schema.md, LICENSE, build.ps1, global.json, platyPS.sln, CHANGELOG.md, nuget.config, CONTRIBUTING.md.
What it can do
Convert Markdown documentation to MAML help format
Markdown files with PowerShell help documentation → MAML (Microsoft Assistance Markup Language) help files
Generate Markdown templates from existing PowerShell modules
PowerShell module files → Markdown template files for documentation
Create external help files for PowerShell cmdlets
Markdown documentation files → PowerShell external help files
Extract help content from PowerShell modules
PowerShell module with existing help content → Structured help information
Validate PowerShell help documentation structure
Markdown help files → Validation results and error reports
Tags
Tech Stack
Comments (0)
No comments yet
Editorially curated, with community endorsements as a secondary signal. Corrections welcome.