INSTALL.md

Project Zeppelin / GDG DevFest 2014 site template

About

Project Zeppelin allows you to setup awesome GDG DevFest site in 5 minutes.

Project is built on top of Jekyll - simple, blog-aware, static site generator. Jekyll also happens to be the engine behind GitHub Pages, which means you can use Jekyll to host your website from GitHub’s servers for free. Learn more about Jekyll.

Template is brought by GDG Lviv team.

Local development

Check if you have all requirements for local environment. To install all development dependencies install Bundler.

gem install bundler

and run next command from root folder:

bundle install

To start Jekyll run:

jekyll serve -w

Site will be available at http://127.0.0.1:4000/ or http://localhost:4000/

NOTE: in this mode all changes to html and data files will be automatically regenerated, but after changing _config.yml you have to restart server.

Sass(Compass) support

Note: You need to install Node.js

To watch changes of .sass files and compile it to the .css on a fly change property safe: true to safe: false in _config.yml. Note: It works only on local machine, because GitHub runs Jekyll in --save mode

Learn more about Sass development from documentation.

compass watch

Documentation

Quick-start guide is not enough? Checkout full documentation.

Used libraries

• Bootstrap
• Animate.css
• Waves
• jquery.appear
• jQuery countTo Plugin
• Typed.js
• Sticky-kit

Contributors

• Design and web development: Oleh Zasadnyy
• Idea: Vitaliy Zasadnyy

See list of contributors

Maintainers: @tasomaniac and @ozasadnyy.

License

Project is published under the MIT license. Feel free to clone and modify repo as you want, but don't forget to add reference to authors :)