Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/geekuillaume/geekuillaume-blog

Personal Blog build with Jekyll and Angular.js
https://github.com/geekuillaume/geekuillaume-blog

Last synced: 7 days ago
JSON representation

Personal Blog build with Jekyll and Angular.js

Awesome Lists containing this project

README

        

Geekuillaume Blog
=================

This repository host my personal blog built with Jekyll.
Much more to come, stay tuned !

Dependancies
------------

- [Ruby](http://www.ruby-lang.org/en/) to use [Jekyll](http://jekyllrb.com/) for site building
- [Node.js](http://nodejs.org/) to use [Grunt](http://gruntjs.com/)
- [optipng](http://optipng.sourceforge.net/) and [jpegtran](http://jpegclub.org/jpegtran/) for image optimization

Installation
------------

- Install Jekyll with `gem install jekyll`
- Run `npm install` to install all Node.js dependancies
- Install Grunt CLI with `npm install -g grunt-cli` (as root or with sudo)
- On Debian / Ubuntu and other, use `apt-get install optipng libjpeg libjpeg-progs` to install optipng and jpegtran. On other plateforms, see respectives sites to installation instructions

Usage
-----

- Use `grunt` to lauch the optimization of assets (css / js / images) and site building with Jekyll
- The site is now ready and stored in the dist directory. You just have to serve it with you favorite Web server (like [nginx](http://nginx.org/))

You can also use the `grunt server` command to watch for changes in your files or posts and automatically rebuild what's need to be rebuilt and serve it on the 8000 port (accessible on the address http://127.0.0.1:8000/).

Use with Github
---------------

You can use Github to automatically update your site on your server when you push a commit to your repository.
To do so, change the port in the `updater.js` to something random and add a WebHook URL in your Github repo to your server IP (with the right port). This will do a request every time you push a commit and update the dist repository on your server.

Don't forget to lauch the `updater.js` file with the command `node updater.js`.

If your blog is behind [Cloudflare CDN](https://www.cloudflare.com/) this script can also purge the website cache once the site rebuilt. To do so, simply add your CloudFlare email, token and domain in the `updater.js` file