HTML Boilerplate
HTML starter project including full setup for gulp, Sass, Autoprefixer, Browserify, imagemin, Browsersync, PostCSS etc.
Documentation
System Preparation
To use this starter project, you'll need the following things installed on your machine. Nodejs user the installer, Homebrew, etc.
Local Installation
Clone this repo, or download it into a directory of your choice.
$ git clone https://github.com/nathanhenniges/html-boilerplate.git
Inside the directory, run npm install
.
$ cd html-boilerplate
$ npm install
Usage
Note: If you have trouble with the commands, prepending bundle exec
to your
commands may solve it. e.g.
$ bundle exec npm start
Start the Development
This will give you file watching, browser synchronisation, auto-rebuild, CSS injecting, etc.
$ npm start
See More Commands
This will display all available commands.
$ npm run
What's in DemonWolf Jekyll Boilerplate
Configuration and Defaults
You can change the configurations by editing mrdemonwolf.config.js
Port
default: 4000
options: integer
Tasks
Tasks to run when you exec npm start
or gulp
commands.
-
Imagemin To minify images. default:
true
options: boolean (true
/false
) -
sass To compile Sass. default:
true
options: boolean (true
/false
) -
server To compile sources and to keep browsers in sync with file changes via Browsersync. default:
true
options: boolean (true
/false
)
Paths
Settings related to the paths.
-
dest The destination directory for the whole project. default:
"/"
options: string -
assets The directory to gather all assets. default:
"./assets"
options: string -
css The CSS desination directory for Sass. default:
"css"
options: string example:"stylesheets"
-
js The JavaScript destination directory for Browserify default:
"js"
options: string example:"javascripts"
-
images The destination directory of compressed image files for imagemin. default:
"images"
options: string example"img"
-
sass The directory of Sass files. default:
"_sass"
options: string example:"src/sass"
-
jsSrc The directory of JavaScript source files to bundle up by Browserify. default:
"_js"
options: string example:"src/js"
-
imagesSrc The directory of image source files to compress. default:
"_images"
options: string example:"src/images"
Sass
Sass settings.
- outputStyle
Teh output style of Sass.
default:
"compressed"
options:"expanded"
,"nested"
,"compact"
,"compressed"
autoprefixer
Autoprefixer settings
- browsers
List of browsers, which are supported in your theme.
default:
["> 1%", "last 2 versions", "Firefox ESR"]
options: array. See Browserslist docs for available queries. example:["> 5%", "last 2 versions", "IE 8"]
JS
JavaScript settings.
- entry
File name(s) of JavaScript entry points.
default:
["main.js"]
options: array example:["pluginA.js", "pluginB.js", "main.js"]
Copyright and License
Copyright 2018 MrDemonWolf. Code released under the MIT license.