search

devblackops / building-powershell-modules-feedback

Feedback on the PowerShell Module Development book
6 stars 1 forks source link

Topic proposal: How to write and include help files as markdown #30

Open klennan opened 3 years ago

klennan commented 3 years ago

Topic

I would like to learn how to move from comment-based help to XML help files in a module. Including, but not limited to, how to format them, where in the build directory to store them, and incorporating them in the build script. Possibly even the method to allow the end user to use Update-Help.

Why should this be included?

XML help is supposed to be "the way" for professional modules.

reference: https://twitter.com/KevinLennan/status/1303012833865748480

devblackops commented 3 years ago

This is planned for chapter 13.