jekyll-cardinal

A boilerplate for Jekyll using the Cardinal LESS framework.

• Getting Started
  • Prerequisites
  • Installation
  • Resources
• Developing
• Deploying
• Known Issues

Getting Started

The following instructions will help you get up and running, so that you can start using this project from your local machine.

Prerequisites

This project depends on some software that must already be installed on your machine before proceeding.

• Git (Mac users should already have this)

• Ruby (Mac users should already have this)

• Bundler

  After installing Git and Ruby, you can install Bundler by running the following command(s)*:

  gem install bundler
  

  *Mac users may need to use sudo gem install bundler instead.

• NodeJS (Use the installer)

• Bower

  After installing Git, Ruby, and Node, you can install Bower by running the following command(s)*:

  npm install -g bower
  

  *Mac users may need to use sudo npm install -g bower instead.

Installation

Once you have the above tools installed, you can clone this repository to your local machine, where you will be making your changes.

1. Create a directory for this project on your machine, navigate to it, and clone this repository from GitHub into your directory by running the following command(s):

cd path/to/your/projects/folder
mkdir newproject.com && cd newproject.com
git clone https://github.com/cbracco/jekyll-cardinal.git .

2. Create a repo for your new project, then update your the origin remote to point to your new project by running the following command(s):

git remote set-url origin [email protected]:your-username/newproject.com.git

3. Install project dependencies by running the following command(s):

bundle
npm install
bower install

4. Build the site and spin up a local server by running the following command(s) from your terminal:

gulp

5. Navigate to http://127.0.0.1.xip.io:9999 in your browser and begin working!*

*This project uses BrowserSync and xip.io to automatically refresh your web browser on save, and to synchronize file changes and basic browser interactions (scrolling, clicking) across multiple devices. After running gulp in the terminal, you will see an “External URL” (e.g. http://192.168.1.114.xip.io:9999) that you can use for your various devices. Simply navigate to this URL in the browser of another device connected to your network, and watch your changes and interactions happen across multiple devices at the same time!

Resources

If you are running Windows on your machine, and you’ve run into problems with the above, then you might find these guides useful:

• Jekyll on Windows
• Run Jekyll on Windows

Developing

After running gulp, you should have a development server environment running on your local machine, and you can begin working.

Publishing

To publish a production-ready version of your project, run the following command(s):

gulp publish

This task will delete any existing builds, build a production-ready version with your latest changes, and spin up a local server for you to test.

Navigate to http://127.0.0.1.xip.io:9998 in your browser to view your local production build.

Deploying

Right now, a simple rsync deploy task is included so you can upload a production build to the server of your choice. You will want to modify the Gulp configuration to reflect your real server credentials.

To deploy your project via rsync, run the following command(s):

gulp deploy

Known Issues

Issues are logged and tracked in using GitHub’s Issues feature in this repo.