Step-by-Step Github/Jekyll Project

May 19, 2020

After having a hard time finding a comprehensive and up-to-date guide on integrating Github and Jekyll for project sites, I decided to create my own.

These instructions are for Windows users who already have Jekyll (either v3.8 or v4) and Node.js (v.12.16) installed.

  1. On the Github website, create a new repo.
  2. Open Command Prompt at your parent folder and enter jekyll _3.8.5_ new <REPO>
  3. cd to the new folder
  4. git init
  5. bundle exec jekyll serve
  6. Insert node_modules to your new .gitignore
  7. Create your folder structure. I personally set up my projects like this: 
    _data
_drafts
_includes
_js
_layouts
_libs
_sass
assets
  assets/img
  8. Add your Gruntfile.js and package.json
  9. Add any other pages and assets.
  10. npm install
  11. grunt serve
  12. Use Github Desktop to push your changes.