The purpose of these starter files are to provide a starting point for a set of flat HTML files that can be used as a prototype or a starting point for further templating in a web app or CMS.
- Clone repository or download the ZIP file
- Inside the project folder run the following
npm installbower install
- Type
gruntto build and watch for changes
- NodeJS/NPM
- Grunt (installed globally) (
npm i -g grunt-cli)
These tools are all installed when you run npm install and bower install after cloning the repo.
Sass, Autoprefixr (via PostCSS), Modular Scale SASS library
Autoprefixr defaults to "last two versions" but, if you need to adjust based on your requirements: https://github.com/ai/browserslist#queries
- JQuery
- Modernizr
- Object Fit Images polyfill for IE use of
object-fit
Default file based on HTML5 Boilerplate
Codekit .kit files for very simple templating with little to no overhead.
- Includes:
<!-- @import 'partials/_partial.kit' --> - Variables:
<!-- $title: My Great Website --><title><!--$title--></title>=><title>My Great Website</title>
Codekit app not required. Uses grunt-codekit plugin. Grunt watch will keep this running and compiling based on the watched files. CTRL-C to quit.
Here is everything you can do with kit: https://codekitapp.com/help/kit/
LiveReload is on - snag the LiveReload Chrome Plugin easy working.
Bower is used to pull down and manage components in src/bower_components. It is not set up to use those components directly (except for the modular scale), so copy-paste what you need from bower's download directory, or hack it yourself.
Working files are in src/ directory. Built files output to dist.
It's recommended that you do your own image minification or hack your own automation.
Recommended SVG optimization tool: https://jakearchibald.github.io/svgomg/
Based on:
The starter files include some elements from the following open source projects: