Skip to content

bdavidxyz/impatient-jekyll

Repository files navigation

Impatient-Jekyll

Opinionated Jekyll starter kit
Get a fast local workflow, and a strongly optimized website in production.

How to use it

Prerequisite

  • Ruby - use the installer
  • Jekyll - $ gem install jekyll
  • NodeJS - use the installer.

Tested with : node 5.12.0, jekyll 3.1.6, ruby 2.3.0

Dev mode

$ git clone https://github.com/bdavidxyz/impatient-jekyll
$ cd impatient-jekyll
$ npm install
$ $(npm bin)/gulp
 # ta-da ! the browser launches itself,
 # and will rebuild and live-reload each time you
 # change a CSS, JS, or HTML file

Production mode

The website will deploy on branch gh-pages, so create a new repository <your_repo_name> in Github, and add the remote in your project like this :

# be sure you start from a fresh GitHub state
$ rm -rf .git
$ git init
$ git add . && git commit -m 'initial commit'
$ git remote add origin [email protected]:<your_github_name>/<your_repo_name>.git
# in config.prod.yml, set baseurl to <your_repo_name>
$ git push -u origin master

# I suppose you've already run npm install ?
$ gulp deploy
# ta-da ! your super optimized website
# can be see at  https://<your_github_name>/<your_repo_name>/

Special Thanks

I used the following resources to achieve the tools :

About

Build a website yourself. Easy to use, get a fast workflow and fast website. http://bdavidxyz.github.io/impatient-jekyll/

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published