search

dsccommunity / DscResource.DocGenerator

Module for generation of DSC resource documentation
MIT License
9 stars 10 forks source link

Remove-EscapedMarkdownCode: Need to remove code blocks that are escaped #140

Closed johlju closed 10 months ago

johlju commented 10 months ago

Details of the scenario you tried and the problem that is occurring

When markdown is generated by PlatyPS code blocks are escaped. The command Remove-EscapedMarkdownCode should remove those too.

`\``mermaid
`\``

Steps to reproduce the problem

Run the task Generate_Markdown_For_Public_Commands.

Expected behavior

To have a correct code block.

Current behavior

Does not remove escaped code blocks.

Suggested solution to the issue

Add a regex to the command: https://github.com/dsccommunity/DscResource.DocGenerator/blob/c40598aba88653e7b46dc63b24305c26bed84ea8/source/Private/Remove-EscapedMarkdownCode.ps1#L41-L55

The operating system the target node is running

n/a

Version and build of PowerShell the target node is running

n/a

Version of the module that was used

0.16.1