platyPS
platyPS copied to clipboard
Generate Help from Module Manifest psd1 file
Would it be possible to generate markdown help, probably closer related to the about help markdown creation via a module manifest psd1 file? Or is there perhaps a best practice I'm not seeing for generating a general help file for a module? Like am I supposed to generate the about template and just fill that in manually for each module?
Also, would it be possible to generate markdown of the releasenotes, version information, and anything in the @PSDATA sectiion really. I feel it would be helpful and they are already part of built in standards of powershell modules. Why not make them more accessible in help files?
It's a great idea. The about help file can definitely use some love and improvements. Perhaps, a new parameter set for New-MarkdownAboutHelp
that would take the module information and provide a more specific template. I think it's a lovely idea. Do you want to take a stub at it?
It might be a month or so before I have real time to dedicate to it. But I can give it shot.
We have reviewed the request and discussed the options. This is not a feature that we want to invest in. Most people solve this in their build scripts.