platyPS icon indicating copy to clipboard operation
platyPS copied to clipboard

There is no cmdlet to process about help topics in the Microsoft.PowerShell.PlatyPS

Open peetrike opened this issue 1 year ago • 3 comments

Summary of the new feature / enhancement

The old module (PlatyPS) was able to process about help topics from markdown to .help.txt files. The new modules seems to not have that ability.

Proposed technical implementation details (optional)

No response

peetrike avatar Nov 01 '24 09:11 peetrike

The only support the old platyPS module had for about_* topics was to create an empty template. There are no plans to add this to the new version.

sdwheeler avatar Mar 10 '25 15:03 sdwheeler

platyPS v0.14.2 is able to convert existing about_.md files to about_.help.txt files. The conversion is not the best, but it exists. Specifically, New-ExternalHelp (https://github.com/PowerShell/platyPS/blob/master/src/platyPS/platyPS.psm1#L921-L933) does that.

peetrike avatar Mar 10 '25 15:03 peetrike

Reopen for further investigation. This feature doesn't work with the way we format about_.md files for our publishing system. We use Pandoc to convert the about_.md files in our build system.

sdwheeler avatar Mar 10 '25 15:03 sdwheeler