Guidelines for writing sane, maintainable and scalable Sass.
HTML CSS JavaScript Other
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
_bin
_includes
_layouts Removed appcache from <html> element Jan 12, 2017
_locales
assets Fixed broken edition links Aug 15, 2016
pages Updated author’s age in bio Jan 16, 2017
.gitignore
.travis.yml
CHANGELOG.md added "Rewrote the section about PostCSS" into the 1.3 changelog Nov 19, 2016
CODE_OF_CONDUCT.md
CONTRIBUTING.md Improved CONTRIBUTING.md and TRANSLATING.md Jul 22, 2015
Gemfile Replaced github-pages gem with jekyll gem Aug 14, 2016
Gemfile.lock
LICENSE Added a LICENSE file Mar 3, 2016
README.md
TRANSLATING.md
_config.dev.yml
_config.yml
humans.txt
offline.appcache
package.json Updated loadCSS to 1.2.0 Aug 14, 2016

README.md

Sass Guidelines

An opinionated styleguide for writing sane, maintainable and scalable Sass.

Code of Conduct

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.

License

The code for this project is licensed under MIT. The content for this project is licensed by Creative Commons Attribution 4.0 International.

Local development

bundle install
npm install
npm start
# http://localhost:4000

npm tasks

  • start: runs the build task and then the watch 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 the watch task only.
  • watch: runs Jekyll in development mode (local environment, file watcher, dev config, incremental build).
  • build: runs the icons, js:build tasks. npm automatically executes the postbuild task after the build task. The postbuild task runs the bin/testbuild Bash script. This script makes sure the build happened correctly.
  • icons: Generates _includes/sprite.svg. npm automatically executes the preicons task before the icons task. The preicons task runs svgo to optimise SVG files before building the sprite.
  • css:critical: Generates _includes/critical.css.
  • js:build: Runs the js:lint, js:vendors, js:main, js:utilities tasks.
  • js:vendors: Copies third-party vendor scripts into the JavaScript folder (accessible-modal-dialog, blingdotjs, picturefill). The picturefill.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 after npm 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.