platyPS
platyPS copied to clipboard
🚀 [Idea]: Support adding titles to examples
Summary of the new feature / enhancement
Support adding titles to examples.
Changes for comment based help: Should support adding a string after .EXAMPLE
. This text is the title of the test.
The title gets transferred to the markdown, by simply appending it behind ## Example 1: <Title>
.
From the powershell script/module/function:
<#
.EXAMPLE Adding a title to the example
...
.EXAMPLE Showing more examples with titles
...
#>
The generated markdown:
...
## Examples
### Example 1: Adding a title to the example
...
### Example 2: Showing more examples with titles
...
Proposed technical implementation details (optional)
No response