K-MUG official website source code

About

All the geeks of the community can look into contributing to this repo and make this an epic mess :)

Quick-start guide

1. Fork this repo
2. Clone locally
3. Create a new topic branch
4. Commit your changes in logical chunks
5. Locally merge (or rebase) the upstream development branch into your topic branch
6. Push your topic branch up to your fork
7. Open a Pull Request

Check out the detailed contibution explainer

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

Or try this:

    bundle exec jekyll serve

Site will be available at http://127.0.0.1:4000/ or http://localhost:4000/ (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

• Bootstrap
• Animate.css
• Waves
• jquery.appear
• jQuery countTo Plugin
• Typed.js
• Sticky-kit

See list of contributors

Maintainers: @jerriclynsjohn and @anuraj.