jeromegn / DocumentUp

Pretty documentation generator for Github projects with proper Readme.
http://documentup.com
884 stars 90 forks source link

line breaks look ugly from Github-Flavored Markdown Readme #99

Open scottbale opened 9 years ago

scottbale commented 9 years ago

Compare http://revelytix.github.io/backbone-nestify/ with https://github.com/revelytix/backbone-nestify.

The former has ugly line breaks, the latter does not. I'm guessing this is due to the line breaks in the README.md file itself (I have made a change to break all lines at 80 chars).

jeromegn commented 9 years ago

Hey @scottbale,

Yes, we do consider line breaks like new paragraphs. Maybe we should consider changing that setting... hmmm.

scottbale commented 9 years ago

My pitch for that change would be that DocumentUp's layout of GFM would then more closely reflect GitHub's itself. (But I can also just revert my line breaks, it's not a huge deal.) Thanks.

kewisch commented 8 years ago

I'd also appreciate fixing this one. I prefer keeping ~80 characters per line and github flows the text for this nicely, but my documentup site at http://mozilla-comm.github.io/ical.js/ breaks the lines quite bad.