Closed saltire closed 7 years ago
oo, yes you're right - this is caused by a change in the Github markdown parser! Will look into it.. Thanks for letting me know.
btw, I have a testbed project but it has no documentation at all, i should change that.
fixed and released in dmd v3.0.3, please update jsdoc2md.. thanks again.
Thank you!
If a pipe is enclosed in a param type, e.g.
{number|string}
, it will be treated as a delimiter for the table, and the types will be split into different cells. You can see this here: https://github.com/jsdoc2md/jsdoc-to-markdown/blob/master/docs/API.md (jsdoc2md.render() > options.plugin)Looks like this was fixed before by replacing
\|
with|
, but I guess Github changed how they parse Markdown. I think if the|
is enclosed in the<code>
tag, it will render properly: https://stackoverflow.com/questions/17319940/how-to-escape-a-pipe-char-in-a-code-statement-in-a-markdown-table/17320389#17320389.Looked into fixing the partial myself, but wasn't confident I could do it without breaking other parts of the template...