Go to file
Ray Elliott 7b3b5fc013 Update 'README.md' 2020-05-20 20:15:45 +03:00
src add base typography mixins 2020-05-20 18:13:45 +01:00
.browserslistrc restructure directory structure 2020-05-01 15:30:14 +01:00
.eslintignore restructure directory structure 2020-05-01 15:30:14 +01:00
.eslintrc.js restructure directory structure 2020-05-01 15:30:14 +01:00
.gitignore add gulp-svgmin 2020-05-19 17:17:40 +01:00
.prettierrc Update '.prettierrc' 2020-05-15 21:41:38 +03:00
README.md Update 'README.md' 2020-05-20 20:15:45 +03:00
babel.config.js restructure directory structure 2020-05-01 15:30:14 +01:00
gulpfile.js add gulp-svgmin 2020-05-19 17:17:40 +01:00
package.json add gulp-svgmin 2020-05-19 17:17:40 +01:00
yarn.lock add gulp-svgmin 2020-05-19 17:17:40 +01:00

README.md

Build Directory

Default build directory is ./build. To change edit gulpfile.js.

Features

  • JS transpilation, minification with Babel, Terser.
  • SASS compilation, css minification.
  • HTML file includes.
  • Mustache templating
  • SVG optimisation.
  • BrowserSync.

TODO

  • Image optomisation.

Usage

HTML File Includes

Uses gulp-file-include - npm.

Include file with:

@@include('./logo.svg')

Files are relative to the include directory: src/includes/.

Mustache Templates

Include a template with:

{{> templates/example}}

Templates are relative to the HTML file and the .mustache extension must be ommitted.