How to set up a Github Pages site
- Go to Settings > Code and Automation - Pages > Branch - master and enable the deployment of a github pages site.
- If you are working from a clone of a past NYU AI School repository, you will need to update the
baseurlparameter to set it to a new URL from the_config.ymlfile in the root folder of the repository.
git clone git@github.com:nyu-mll/nyc-ai-workshop.git
cd nyc-ai-workshop-2021
gem install bundler
bundle install
# Rakefile is to Jekyll as Makefile is to systems
bundle exec rake site:build # build the site (using a custom rake cmd)
bundle exec rake site:serve # serve the site (using a custom rake cmd)
- Add their details under _data/speakers.yml
- Add their image under img/people/ (remember to use the extension when linking this image under speaker data)
- Same as above, except add organizers under _data/judges.yml
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
Check if you have all requirements for local environment. To install all development dependencies install Bundler.
gem install bundlerand run next command from root folder:
bundle installTo start Jekyll run:
jekyll serve -wSite 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.
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.
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
- Bug fixing and support: Said Tahsin Dane
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 :)