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.
Check if you have all requirements for local environment or consider using this docker image.
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/directory/ or http://localhost:4000/directory/ (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.
- 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 :)