Skip to content

Latest commit

 

History

History
79 lines (61 loc) · 2.92 KB

README.md

File metadata and controls

79 lines (61 loc) · 2.92 KB
Raw

Technology Robotix Society

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 we use Jekyll to host our website from GitHub’s servers for free. Learn more about Jekyll.

Features

  • Easy to setup
  • Simple and responsive design
  • 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 Robotix site at http://[your github name].github.io/

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

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.

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

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

Documentation

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

Used libraries

Contributors

  • Aditya Narayan
  • Abhinav Jain
  • Manad Mishra
  • Pranit Bauva
  • Shivang Agrawal
  • Shubhika Garg
  • Sourish Ghosh