search

PowerShell / platyPS

Write PowerShell External Help in Markdown
MIT License
762 stars 148 forks source link

🚀 [Idea]: Support adding titles to examples #627

Closed MariusStorhaug closed 3 months ago

MariusStorhaug commented 5 months ago

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

sdwheeler commented 3 months ago

This is a feature request for PowerShell. The PowerShell engine that implements comment-based help would need to support this before PlatyPS could do anything with it. Please file an issue with the PowerShell team.