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
- Easy to setup
- Simple and responsive design
- Integrated speakers and sessions management
- SVG icons
- SEO friendly
- 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
The site is a Jekyll project built with the
github-pages gem, so a local build matches what GitHub Pages produces. It
needs Ruby ≥ 2.7 (the github-pages gem won't run on older Rubies — note
that the system Ruby shipped with macOS is too old). The repo pins a known-good
version in .ruby-version, so the steps below use rbenv
to install exactly that.
# 1. Ruby toolchain (Homebrew assumed installed)
brew install rbenv ruby-build
echo 'eval "$(rbenv init - zsh)"' >> ~/.zshrc && exec zsh # one-time shell setup
rbenv install # installs the version from .ruby-version
# 2. Project gems
gem install bundler
bundle install
# 3. Build + serve with live reload
bundle exec jekyll serve -wThe site runs at http://localhost:4000 and rebuilds on every file change. Stop
it with Ctrl-C (or pkill -f jekyll if you started it detached).
Note: changes to HTML and
_datafiles are regenerated automatically, but after editing_config.ymlyou must restart the server.
Install WSL2 (instructions) from an Administrator PowerShell:
wsl --installReboot if prompted, then check the distro is WSL version 2 with wsl -l -v.
From the Ubuntu console, install the build tools, then follow the same rbenv flow
as macOS (using ~/.bashrc instead of ~/.zshrc):
sudo apt update
sudo apt install -y git curl build-essential libssl-dev libreadline-dev zlib1g-dev
# rbenv + ruby-build
curl -fsSL https://github.com/rbenv/rbenv-installer/raw/HEAD/bin/rbenv-installer | bash
echo 'eval "$(~/.rbenv/bin/rbenv init - bash)"' >> ~/.bashrc && exec bash
rbenv install # installs the version from .ruby-version
gem install bundler
bundle install
bundle exec jekyll serve -wSCSS sources live in _sass/ with css/main.scss as the entry point. It is
compiled to css/main.css automatically by Jekyll's built-in
jekyll-sass-converter — both locally (jekyll serve/build) and on GitHub
Pages. Do not edit or commit css/main.css; it is generated output
(git-ignored). Edit the partials under _sass/ instead.
This project previously compiled Sass with Compass via a custom plugin in
_plugins/, which required committing the built CSS by hand. That pipeline has been removed in favor of Jekyll's native Sass support.
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 -svgoTo minify CSS and JS run minify_js.bat (for Windows) and minify_js.sh (for Linux and MacOS) from /automation/minifying/ folder:
minify_js.batLearn more about available optimization options from documentation.
Quick-start guide is not enough? Checkout full documentation.
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.
- Design and web development: Oleh Zasadnyy
- Idea: Vitaliy Zasadnyy
Maintainers: @tasomaniac and @ozasadnyy.
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 :)