Markdown output should escape the output

[stephentoub]

Various characters (e.g. |) if used in a Params will end up invalidating the generated markdown, causing it to render incorrectly. It'd be helpful if benchmarkdotnet could escape the markdown output, e.g. output \| instead of |.

[adamsitnik]

I've marked the issue as up-for-grabs. Here are some hints for contributors interested in fixing the issue:

• The tests for markdown exporter can be found here. Simplest way of testing that would be adding a new type with some [Params("$needToBeEscaped", "$doesNotNeedToBeEscaped")] public string Name field. And a file for expected output here
• The logic that needs to be fixed can be found here

[mawosoft]

This should IMHO exclude the Console Markdown exporter and rely on an escape flag like the existing EscapeHtml.
I'm reasonably familiar with GitHub Markdown, but not with the other flavors - there might be different character sets to escape depending on dialect.

(The easiest workaround is to just use the Console exporter and put it in a code fence)

[YegorStepanov]

System symbols (\a, \t, \n, etc) also break markdown and most likely other exporters too. Should be they escaped?

If yes, then the following parameters will be the same:

[Param("\t", @"\t")]

System symbols can be colored in a different color, but only for the console.

Oops, forgot that @"\t" gives "\\t".