Repository navigation
markdown special symbols in commit description should be escaped #47
Description
The commit messages are initially in text, so rendering them as Markdown can cause errors.
To reproduce, in node, do:
$ changelog-maker --start-ref=9eddaebb --end-ref=9eddaebb
* [[`9eddaebb79`](https://github.com/nodejs/node/commit/9eddaebb79)] - **assert**: remove unnecessary use of __proto__ (Nathan Rajlich) If a changelog includes __proto__, we don't want it to render as «proto», we want to render it as «__proto__» or «__proto__». Without knowing more if that is code block or not, it would make sense to just escape some symbols like `_*~\, prefixing those with \.
Refs: nodejs/node#a58b48bc3bc, nodejs/node#7637, nodejs/node#12756 (comment).
Reacted by Daijiro Wachi and Titus
Activity
[-]changelog-maker should escape markdown special symbols in commit description[/-][+]markdown special symbols in commit description should be escaped[/+]wooorm commentedon May 1, 2017
Hi folks! 👋
Shameless plug, but maybe remark can help here, as it automatically deals with escapes and stuff! Here’s an example of how it could look, where a readme is generated from a
package.jsonin a monorepo.Let me know if that’s of interest!
MylesBorins commentedon Feb 13, 2018
BUMP to this
This actually broke CI today as it broke the markdown linter
nodejs/node#18767
added markdown escapes for _*~\
rvagg commentedon Mar 1, 2018
fixed in #52, pls 👍
added markdown escapes for _*~\