An opinionated styleguide for writing sane, maintainable and scalable Sass.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.
The code for this project is licensed under MIT. The content for this project is licensed by Creative Commons Attribution 4.0 International.
bundle install
npm install
npm start
# http://localhost:4000
start
: runs thebuild
task and then thewatch
task. It is used when cloning the project for the first time in order to work on it. After the first time, you can run thewatch
task only.watch
: runs Jekyll in development mode (local environment, file watcher, dev config, incremental build).build
: runs theicons
,js:build
tasks. npm automatically executes thepostbuild
task after thebuild
task. Thepostbuild
task runs thebin/testbuild
Bash script. This script makes sure the build happened correctly.icons
: Generates_includes/sprite.svg
. npm automatically executes thepreicons
task before theicons
task. Thepreicons
task runs svgo to optimise SVG files before building the sprite.css:critical
: Generates_includes/critical.css
.js:build
: Runs thejs:lint
,js:vendors
,js:main
,js:utilities
tasks.js:vendors
: Copies third-party vendor scripts into the JavaScript folder (accessible-modal-dialog, blingdotjs, picturefill). Thepicturefill.min.js
is not copied in the vendor folder because it is being included in the<head>
instead of being bundled in the main JavaScript file like other vendors. npm automatically executes this task afternpm install
.js:utilities
: Generates_includes/utilities.js
from third-party vendor scripts (loadCSS, woff2-feature-test, OptimizedWebfontLoading). These utilities are being inlined in the<head>
instead of being bundled in the main JavaScript file.js:main
: Generates the minified main JavaScript file with rollup.js:lint
: Runs semistandard on the JavaScript source folder.