\- are not escaped in output

[vapier]

unescaped - run the risk of being automatically converted to other characters in outputs depending on what follows it. -- is commonly converted to an – (U+2013 endash). this is undesirable for code documentation like command line options as they no longer can be copied & pasted. that's why man pages will often write \-\-foo for the --foo command line option.

depending on the renderer, markdown has this feature as well -- it creates endashes whenever it sees --. this def happens on github pages for example.

the current man-to-md script will strip away the \ from something like \-\-foo yielding --foo which turns into –foo which is not good :).

i think just leaving \- as \- should be fine for most markdown renderers ?

[mle86]

Doesn't seem to be a problem with the README.md renderer:
see https://github.com/mle86/man-to-md/blob/v0.15.4/README.md#options

But I can easily add a command line option to escape all dashes in the output.

[vapier]

not sure where this is documented. GitHub pages seem to more actively convert content which is where i've been seeing the "--" converted to endashes. smart quotes are a common thing too, although less commonly a problem (e.g. "foo" to “foo”).

[vapier]

thanks, it works well for me now