-
Notifications
You must be signed in to change notification settings - Fork 127
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Style guide #5
Comments
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++ |
+1 on the 80 character limit. I also do this in my environment. Is there a tool for enforcing style guides in markdown docs? |
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. |
Style the guide and add an MLH Header
The text was updated successfully, but these errors were encountered: