MLH / mlh-hackathon-organizer-guide

MLH Hackathon Organizer Guide
https://guide.mlh.io
Other
319 stars 126 forks source link

Style guide #5

Open jonmarkgo opened 9 years ago

jonmarkgo commented 9 years ago

Style the guide and add an MLH Header

Robmaister commented 9 years ago

A column limit should be enforced instead of having each paragraph run on as a single line. It doesn't look that great as a raw text document, and Markdown emphasizes readability above all else, including publishing as a plain-text document.

There's also some evidence that there is an ideal line length for documents.

I maintained an 80-column limit for markdown in one of my projects, the documents look great in plaintext as well: https://raw.githubusercontent.com/Robmaister/100daysofhacking/gh-pages/_posts/2014-12-30-day-6.md

For comparison, here's how the guide looks for me in Notepad++

image

theycallmeswift commented 9 years ago

+1 on the 80 character limit. I also do this in my environment. Is there a tool for enforcing style guides in markdown docs?

Robmaister commented 9 years ago

Not that I know of/could find within a few minutes. If we just want line length I could whip up a bash script to be run on TravisCI in a few minutes.

Should be as simple as getting each line length with awk and only printing when length > 80, then checking if awk's output is empty.