jsdoc-to-markdown icon indicating copy to clipboard operation
jsdoc-to-markdown copied to clipboard

Multiline not working on some markdown sites

Open BHare1985 opened this issue 10 years ago • 7 comments

On NPM the multiline examples aren't working:

https://www.npmjs.com/package/binaryquadkey

Not sure if github is your only md target or not.

BHare1985 avatar Nov 07 '15 17:11 BHare1985

interesting.. something, somewhere is using the windows carriage return character (^m or \r) as a line ending in the rendered @example output.. it's not something jsdoc2md does deliberately.. which version of Windows are you on? (so i can reproduce)

in the meantime, you can fix this by running a tool over your README.md which normalises line endings to use the unix standard of \n

75lb avatar Nov 07 '15 21:11 75lb

I am running windows 10

BHare1985 avatar Nov 08 '15 00:11 BHare1985

hi, is this still an issue (with the latest version)?

75lb avatar Dec 05 '15 14:12 75lb

closing until i get feedback

75lb avatar Dec 19 '15 23:12 75lb

Hi, using jsdoc2md version 3.0.0. We still have the problems that every now and then '^M' characters are in the markdown. Using Windows 10. Formatting the files to linux ending does not change the output.

SamuelBrucksch avatar Nov 28 '17 09:11 SamuelBrucksch

could you do me a favour please - post some simple steps to help me reproduce. I'll need some example failing input and the commands required to create failing output.

75lb avatar Nov 28 '17 10:11 75lb

Actually it is related to https://github.com/jsdoc2md/jsdoc-to-markdown/issues/112 i think. So i guess if you are able to set the line ending it should be fine. Will try to put together a sample though...

SamuelBrucksch avatar Nov 28 '17 11:11 SamuelBrucksch