Skip to content
This repository has been archived by the owner on Aug 28, 2023. It is now read-only.

bashyHQ/opensourcebash.org

 
 

Repository files navigation

Website for OpenSourceBash.org – the hack and tell for OpenSource

based on the work of the Project Zeppelin / GDG DevFest 2014 site template – THANKS HEAPS, FOLKS!

About

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.

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 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

Contributors

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 :)

Packages

No packages published

Languages

  • HTML 51.2%
  • CSS 32.0%
  • JavaScript 13.9%
  • Batchfile 1.7%
  • Other 1.2%