7.8 KiB
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.
Live demo http://gdg-x.github.io/zeppelin/
Automated version with Grunt https://github.com/gdg-x/zeppelin-grunt
Features
- Easy to setup
- Simple and responsive design
- Integrated speakers and sessions management
- SVG icons
- SEO friendly
Quick-start guide
- Fork this repo
- Clone locally
- Update
_config.yml - Select what content blocks do you need
- Push changes to
gh-pagesbranch - 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 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/zeppelin/ or http://localhost:4000/zeppelin/ (on Windows)
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.
Resource optimizations (optional)
You can optimize images and minify css and javascript automatically (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_js.bat (for Windows) and minify_js.sh (for Linux and MacOS) from /automation/minifying/ folder:
minify_js.bat
Learn more about available optimization options from documentation.
Documentation
Quick-start guide is not enough? Checkout full documentation.
Used libraries
Who is using template?
Going to use template? Go on! The only thing we ask - let us know at lviv@gdg.org.ua so we can include you to this list, or make a pull request.
Contributors
- Design and web development: Oleh Zasadnyy
- Idea: Vitaliy Zasadnyy
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 :)