Giter Club home page Giter Club logo

jekyll-foundation's Introduction

Jekyll Foundation

Quickstart your Jekyll (v3) project with Zurb Foundation for Sites (v6, sass).

Build process: Gulp
Asset management: Bower and Composer
Deployment: Make and rsync.

System Preparation

To use this starter project, you'll need the following things installed on your machine.

Required

Ruby and Ruby Gems
Jekyll - gem install jekyll
Bundler - gem install bundler (mac users may need sudo)

NodeJS - use the installer.
GulpJS - npm install -g gulp (mac users may need sudo)
Bower - npm install -g bower

Optional

Git
Composer (installs PHPMailer)
Make (used with rsync for deploying)

Local Installation

Git clone this repository, or download it into a directory of your choice. Inside the directory run

  1. bower install (reference: .bowerrc and bower.json)
  2. npm install (reference: package.json)
  3. bundle install (reference: Gemfile and Gemfile.lock)
  4. composer install (optional, reference: composer.json and composer.lock)

Usage

###Start Gulp gulp
This will build your Jekyll site, give you file watching, browser synchronization, auto-rebuild, CSS injecting etc.

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 adress which is showing up in the terminal window.

http://127.0.0.1.xip.io:3001
Access the Browsersync UI.

Foundation for Sites Components

We don't want to include unused CSS an JavaScript.

For the components you want to use, uncomment the component's  
1. Sass in /assets/scss/foundation/_foundation.scss  
2. JavaScript in the gulpfile.js in PATHS (you need to restart gulp)

Customize the variables used by Foundation in the settings file located in /assets/scss/foundation/.

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.

Deploy your site

Rsync ist 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 this settings since rsync is set to delete the files on the remote path!

Deploy with make deploy.

Credits

This package is based on the starting point from @macbleser (Here's no deploying to Amazon S3 and gulp font tasks).

The compress.html layout is provided by @penibelst.

License

This package is licensed under the terms of the MIT license.

jekyll-foundation's People

Contributors

core77 avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.