Skip to content

Latest commit

 

History

History
130 lines (95 loc) · 5.18 KB

README.md

File metadata and controls

130 lines (95 loc) · 5.18 KB
Raw

Project Zeppelin / GDG DevFest 2014 site template

About

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

Project is builded 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.

Live demo http://gdg-x.github.io/zeppelin/

Features

  • Easy to setup
  • Simple and responsive design
  • Integrated speakers and sessions management
  • SVG icons
  • SEO friendly

Quick-start guide

  1. Fork this repo
  2. Clone locally
  3. Update _config.yml
  4. Select what content blocks do you need
  5. Push changes to gh-pages branch
  6. Enjoy your awesome DevFest site at http://[your github name].github.io/zeppelin/

Or watch project presentation from GDG[x] Townhall meeting. Slides available here

Local development

Check if you have all requirments for local environment, install Jekyll server gem and run this command from project root folder:

    jekyll serve -w

Site will be available at http://127.0.0.1:4000/zeppelin/

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 support

Install Sass. Ruby uses Gems to manage its various packages of code like Sass. In your open terminal window type:

	gem install sass

Also you need to install the latest version of Compass with command

	gem install compass --pre

Then for combining media queries you can use Sass::MediaQueryCombiner plugin. Install with command

	gem install sass-media_query_combiner

And for prefixing css3 properties use Autoprefixer

	gem install autoprefixer-rails

To watch changes in .sass files and compile it to the .css on a fly, run this command from \_sass\ folder

	compass watch -c config.rb -e production

Learn more about Sass development from documentation.

Resource optimizations (optional)

You can optimize images and minify css and javascript automaticaly (for now only on Windows). But for Mac OS users available amazing tool - imageoptim. Thanks @raphaelsavina for link. Optimize all images by running this script from /automation/images/ folder:

    all_image_optimization.bat -d -jtran -pout -pquant -optip -gsicle -svgo

To minify CSS and JS run minify_all.bat from /automation/minifying/ folder:

    minify_all.bat

Learn more about available optimization options from documentation.

Documentation

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

TODO List

  • Optimization scripts for mac and linux

Known issues

  • Scrolling on open navbar

Used libraries

Who is using template?

Going to use template? Go on! The only thing we ask - let us know at [email protected] so we can include you to this list, or make a pull request.

Contributors

Licence

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