-
Notifications
You must be signed in to change notification settings - Fork 64
Getting started
To use this starter project, you'll need the following things installed on your machine.
Git
Ruby and Ruby Gems
Jekyll - gem install jekyll
Bundler - gem install bundler (mac users may need sudo)
NodeJS - use the installer.
Yarn - follow installation instructions
GulpJS - npm install -g gulp (mac users may need sudo)
Composer (installs PHPMailer)
Make (used with rsync for deploying)
Git clone this repository, or download it into a directory of your choice. Inside the directory run
-
yarn(reference: package.json) -
bundle install(reference: Gemfile and Gemfile.lock) -
composer install(optional, reference: composer.json and composer.lock)
Do all that in one step: make install ('composer install' disabled by default)
yarn start
This will build your Jekyll site, give you file watching, browser synchronization, auto-rebuild, CSS injecting, Sass sourcemaps etc.
yarn build
This builds your site for production, with minified CSS and JavaScript. Run this before you deploy your site!
http://127.0.0.1.xip.io:3000
Here you can access your site. If you want to access it with your phone or tablet, use the external access address which is showing up in the terminal window.
http://127.0.0.1.xip.io:3001
Access the Browsersync UI.
We don't want to include unused CSS or JavaScript.
Uncomment the components you want to use
1. Sass in /assets/scss/foundation/_foundation.scss
2. JavaScript in /gulp/config.yml in javascript.src (you need to restart gulp)
Customize the variables used by Foundation in the settings file located in /assets/scss/foundation/.
Copy the default settings from the foundation-sites package (/node_modules/foundation-sites/scss/settings/_settings.scss) and then change them to your needs.
Place your custom sass in the subfolders of /assets/scss/. These folders follow the SMACSS architecture. This should be the most scalable solution - from small to very large sites.
Rsync is used here to sync our local _site with the remote host. Adjust the SSH-USER, SSH-HOST and REMOTE-PATH in the Makefile.
Be careful with these settings since rsync is set to delete the files on the remote path!
Deploy with make deploy.
Inline JavaScript can become broken where // comments used. Please remove the comments or change to /**/ style. compress.html Docs