Improve documentation - Githubissues

SC5 / sc5-styleguide

Styleguide generator is a handy little tool that helps you generate good looking styleguides from stylesheets using KSS notation

http://styleguide.sc5.io/

MIT License

1.26k stars 171 forks source link

Improve documentation #1120

Closed d2s closed 6 years ago

d2s commented 6 years ago

docs(README.md) update details

Fix details about minimum Node.js versions required.
Fix capitalization of tool names (SASS --> Sass).
Improve structure of English language sentences.
Run gulp dev:doc to update Table of Contents.
Improve Markdown syntax to fix markdownlint warnings:
- MD022/blanks-around-headers: Headers should be surrounded by blank lines
- MD009/no-trailing-spaces: Trailing spaces [Expected: 0; Actual: 2]
- MD031/blanks-around-fences: Fenced code blocks should be surrounded by blank lines
- MD032/blanks-around-lists: Lists should be surrounded by blank lines
- MD004/ul-style: Unordered list style [Expected: dash; Actual: asterisk]
- MD040/fenced-code-language: Fenced code blocks should have a language specified
- MD034/no-bare-urls: Bare URL used
- MD012/no-multiple-blanks: Multiple consecutive blank lines [Expected: 1; Actual: 2]

docs(DEVELOPMENT.md) update details

Improve consistency of the Markdown syntax
Improve Markdown syntax to fix markdownlint warnings
Fix heading hierarchy (for more consistent document structure)
Fix part deploy command (it was missin gulp)
Fix capitalization of names
Add missing link to the JSCS website.
Add link to the JavaScript coding convention

varya commented 6 years ago

Thank you, Daniel :-)

varya commented 6 years ago

Hi. Your contribution has become a part of 2.1.0 release. Thank you!