Jekyll Quickstart

This Quickstart contains Jekyll layouts and includes to structure a simple site, and also includes Bootstrap as a front end framework.

Installation

Add this line to your Jekyll site's Gemfile:

gem "jekyll-bootstrap-quickstart"

And add this line to your Jekyll site's _config.yml:

theme: jekyll-bootstrap-quickstart

And then execute:

$ bundle

Or install it yourself as:

$ gem install jekyll-bootstrap-quickstart

Usage

Layouts

Includes

Customization

Styling

Add custom styles by overriding the assets/css/main.scss file. Copy this import statement to include all the Bootstrap and Jekyll Quickstart CSS. To start with a clean slate just leave this out.

---
---

// Import custom styles and Bootstrap from Sass files

/*! Jekyll Quickstart CSS
* 
*/

/* Show it is fixed to the top */
.fixed-header-body {
  padding-top: 5rem;
}

// Jekyll Minima Syntax Highlighting
@import "minima-syntax-highlighting";

// Import Bootstrap CSS
@import "lib/bootstrap/bootstrap";

Javascript

Add custom JS to assets/js.main.js

Favicons

Need to be at assets/img/favicons/

Development

To set up your environment to develop this theme (Assumes macOS):

Clone Jekyll Quickstart Repo

bitbucket.org/azaleahill/jekyll-quickstart/

Homebrew

Install Homebrew. brew.sh/

$ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"

Node, npm, and yarn

This project uses yarn as a package manger, and is also compatible with npm. www.npmjs.com/ yarnpkg.com/

$ brew install node
$ brew install yarn

Ruby

Jekyll is built on Ruby. www.ruby-lang.org/ Install with Homebrew to ensure proper environment variables and permissions.

$ brew install ruby

Bundler

Bundler is a Ruby Gem / package dependency manager. bundler.io/

$ gem install bundler

Jekyll

jekyllrb.com/

$ gem install jekyll

Project Setup

Run install steps for yarn and Bundler

$ yarn install

Run App Locally

See package.json for all available scripts. Run the app locally by executing the following:

$ yarn start

Head on over to localhost:2802/

This will do the following: - Run Jekyll Build - Launching a development web server with livereload at localhost:2802/ - Watching and recompiling when chnages are saved

Build Instructions

See package.json for all available scripts. Build the app for various environments by executing the applicable npm script below:

$ yarn run build-local
$ yarn run build-stage
$ yarn run build-prod

Deployment

Requires the s3cmd

$ brew install s3cmd

See package.json for all available scripts. Deploy the app for various environments by executing the applicable npm script below. See jekyll-ezdeploy README for more info

$ yarn run deploy

Contributing

Bug reports and pull requests are welcome on BitBucket at bitbucket.org/azaleahill/jekyll-quickstart/ This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The theme is available as open source under the terms of the MIT License.