riverco.de gulp boilerplate.
/src/ - thats where you write code.
/build/ - compiled code. Do not ever edit this folder.
We have two options for building html
-
/src/index.htmland/src/partials/- for old school HTML. -
Optionally one can use
Jade(it's commented in gulpfile.js). Basic template is in/src/jade/
Sass is compiled and postprocessed with Autoprefixer. We are using gulp-ruby-sass, so don't forget to install Ruby and Sass to use this boilerplate.
src/img/icons are joined into sprite, which could be used in Sass like this:
.icon
+s(png_name)
src/img/svg are joined into icon font, and can be used like this:
<i class="icon-svg_name"></i>
We are also using simplest include system with gulp-rigger, works for javascrpt and html:
//= partials/partial.html
We use BEM naming, meaning .block for independent block. .block__element for elements inside that block. And .block_modification for modification of the block.
It's noce to name layout blocks with .l-* prefixes. So you know it's layout.
States of the blocks use prefix .is-*. .is-running, .is-hidden, .is-open.
For javascript hooks we use prefix .js-*.
Have fun using it, or borrowing some parts. In case of issues or ideas just create them on github. Or write us at html@coderiver.com.ua.
gl & hf.