Using HelpWriter to generate GitHub README.md

This forum can be browsed by the general public. Posting is limited to current SAPIEN license holders with active maintenance and does not offer a response time guarantee.
Forum rules
DO NOT POST LICENSE NUMBERS, ACTIVATION KEYS OR ANY OTHER LICENSING INFORMATION IN THIS FORUM.
Only the original author and our tech personnel can reply to a topic that is created in this forum. If you find a topic that relates to an issue you are having, please create a new topic and reference the other in your post.

Any code longer than three lines should be added as code using the 'Select Code' dropdown menu or attached as a file.
User avatar
HONDAAL
Posts: 10
Last visit: Mon Mar 08, 2021 1:54 pm

Using HelpWriter to generate GitHub README.md

Post 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.

User avatar
brittneyr
Site Admin
Posts: 795
Last visit: Thu Jun 17, 2021 7:35 am
Answers: 15
Been upvoted: 11 times

Re: Using HelpWriter to generate GitHub README.md

Post 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
Brittney Ryn
SAPIEN Technologies, Inc.

User avatar
HONDAAL
Posts: 10
Last visit: Mon Mar 08, 2021 1:54 pm

Re: Using HelpWriter to generate GitHub README.md

Post by HONDAAL »

Thanks for confirming. I've submitted the request.