A dead-simple starting point for static site development via Gulp.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
public
src
.gitignore
README.md
gulpfile.js
package-lock.json
package.json

README.md

Static Site Boilerplate

A dead-simple starting point for static site development via Gulp.

Objectives

  • Compile handlebars templates and partials
  • Compile ES6 with babel
  • Compile and autoprefix SASS
  • Run a local server and sync with LiveReload
  • Provide a bare-bones starting point based on HTML5 Boilerplate and Normalize.css
  • Implement portable components that can be included as template partials

Install and Run

  • npm install
  • gulp

Local Server

  • The server is run by gulp-connect
  • The default root directory is public

Templates

  • Templates are found in the /src/templates directory
  • Are suffixed with .hbs
  • Compile to /public and are suffixed with .html only

Partials

  • Partials are found in the /src/partials directory
  • Partials are included in templates via gulp-hb
  • _head.html and _foot.html are based on HTML5 Boilerplate

SASS

  • SASS files are found in the /src/sass directory
  • Files suffixed with .scss are compiled to public/css
  • Filex prefixed with underscores are skipped by the compiler
  • Normalize.css is included in the /src/vendor directory

Components

  • Components are found in the /src/components directory
  • Components can be included as templates partials
  • Components are fully portable, and may contain their SASS and JS. These are compiled to /public/css/components.css and '/public/js/components.js'.

Static Assets

  • Static assets such as images, fonts and vendor libraries can be placed directly in /public

JSON Data

  • All JSON data in /src/data/*.json is available to handlebars templates and partials

##License MIT © Andrew Bowles