Closed mdaneri closed 1 month ago
I still need to do with this. I plan to make a change in Pode.build.ps1 to automatically create an MD document with any example with a brief description + a test to check if any example has the correct header for the build to generate the page. The Webhook sample is an example of what I mean
Aah I see, in a similar way to how the Function MDs are made with PlatyPS?
Couple of ideas, apologies if these are already planned! Would it be worth adding the following headers?
.LINK
, with a URL back to the example in GitHub.EXAMPLE
, with how to invoke the script; which for most will likely just be some form of ./<file-name>.ps1
.LINK is available on the summary page .EXAMPLE do you think is really needed?
Changes:
.SYNOPSIS
and.DESCRIPTION
.SYNOPSIS
and.DESCRIPTION
and.NOTE
Header Example