Page 1 of 1

Using HelpWriter to generate GitHub README.md

Posted: Tue Nov 24, 2020 1:37 pm
by HONDAAL
Product, version and build: PowerShell HelpWriter 2020 (v2.3.48)
Operating system: Windows 10 1909
PowerShell version(s): v5.1 (Windows)

I would like to use PowerShell HelpWriter to generate a more typically formatted README.md. See this for an example. The project name, description, etc. would be about the module as a whole. The table of contents might list each cmdlet as a link to its respective markdown file. I don't see an obvious way to do this. Am I missing something? Thanks.

Re: Using HelpWriter to generate GitHub README.md

Posted: Wed Nov 25, 2020 8:08 am
by brittneyr
At this time, PowerShell HelpWriter does not generate a readme.md file.
You are welcome to submit a feature request here:
https://www.sapien.com/requests

Re: Using HelpWriter to generate GitHub README.md

Posted: Wed Nov 25, 2020 12:27 pm
by HONDAAL
Thanks for confirming. I've submitted the request.