search

PowerShell / platyPS

Write PowerShell External Help in Markdown
MIT License
766 stars 149 forks source link

Is it possible to generate an about_<module> file from the Module Landing page? #562

Closed powercode closed 2 years ago

powercode commented 2 years ago

The .md file seems to be filtered out in New-ExternalHelp.

How can I make it into an about_<module>.help.txt?

sdwheeler commented 2 years ago

PlatyPS never fully implemented support for about* topics. There is one cmdlet New-MarkdownAboutHelp that creates a markdown template for an about file. You then have to edit it to add the information you want. PlatyPS does not have a cmdlet to convert that markdown to a .txt file for Get-Help. We use Pandoc to do the conversion. You can see an example of how we convert it at: https://github.com/MicrosoftDocs/PowerShell-Docs/blob/fb40c3c45502bae707c07f9a0d861244fd76bdb8/build.ps1#L113-L134

You just need to copy the text file to the appropriate folder location when you install the help.