JonnyOThan / TweakScale

Forked from Gaius Goodspeed's Goodspeed Aerospace Part & TweakScale plugin
Other
3 stars 2 forks source link

Escape underscores in readme.md #60

Closed HebaruSan closed 7 months ago

HebaruSan commented 7 months ago

The underscore character marks the beginning and end of italics in Markdown. To use it as a normal character, it's supposed to be prefixed with a backslash. Except in URLs, which can be wrapped in <> instead.

Noticed while reviewing KSP-CKAN/NetKAN#9920.

JonnyOThan commented 7 months ago

Thanks! Do you have a validator or something? I'm surprised nothing has yelled at me yet.

HebaruSan commented 7 months ago

I just saw some red highlights in GVim (my default text editor when opening from a ZIP). Markdown parsers are usually really forgiving, so presumably most would notice that there's only one on the line and treat it differently.