Install

There are multiple ways of installing Hydejack. The easiest and cleanest way is via the Starter Kit. Alternatively, you can use the Ruby gem. If you don’t mind a cluttered source directory, you can use the zip file. Finally, If you know what you are doing, you can fork the git repository.

Buyers of the PRO version should follow these steps.

Table of Contents

1. Via Starter Kit
2. Via gem
3. Via zip
4. Via git
5. PRO Version
   1. PRO via GitHub (advanced)
6. Running locally

Via Starter Kit

Using the Starter Kit has the advantage of not cluttering your blog repository. Additionally, it allows you to publish your site on GitHub Pages with a single push.

If you have a GitHub account, fork the hydejack-starter-kit repository. Otherwise download the source files and unzip them somewhere on your machine.

NOTE: In addition to the docs here, you can follow the quick start guide in the starter kit.

cd into the directory where _config.yml is located and follow the steps in Running locally.

Via gem

Jekyll has built-in support for using themes that are hosted on RubyGems.

If you haven’t already, create a new Jekyll site first:

$ jekyll new <PATH>

Your site’s root dir should look something like this

├── _posts
│   └── 2017-04-07-welcome-to-jekyll.markdown
├── _config.yml
├── about.md
├── Gemfile
├── Gemfile.lock
└── index.md

NOTE: Hydejack works with Jekyll’s default config.yml, but it is recommended that you replace it with Hydejack’s default config file. It contains the names of all config options known to Hydejack and provides sensible defaults (like minifying HTML and CSS in production builds).

Next, you’ll want to add jekyll-theme-hydejack as a dependency by adding the following line to the Gemfile.

gem "jekyll-theme-hydejack"

(You can also remove the old theme jekyll-theme-minima from the Gemfile)

Now you want to edit the _config.yml of your Jekyll site and set Hydejack as the theme. Look for the theme key and set its value to jekyll-theme-hydejack.

theme: jekyll-theme-hydejack

For more information on gem-based themes, see the Jekyll Documentation.

You can now continue with running locally.

Via zip

If you downloaded the extended zip, extract the contents somewhere on your machine. The high-level folder structure will look something like.

├── _data
├── _featured_categories
├── _featured_tags
├── _includes
├── _js
├── _layouts
├── _posts
├── _sass
├── assets
├── _config.yml
├── 404.md
├── about.md
├── index.html
└── posts.md

cd into the directory where _config.yml is located and follow the steps in Running locally.

Via git

If you are familiar with using git, you can add the Hydejack repository as a remote, and merge its master branch into your working branch.

$ git remote add hydejack git@github.com:qwtel/hydejack.git
$ git pull hydejack master

You can also update Hydejack this way. The master branch will not contain work in progress, but will contain major (breaking) changes. This approach is recommended if you intend to customize Hydejack.

You can now continue with running locally.

PRO Version

If you bought the PRO version, you’ve received a zip archive with the following contents:

├── install
├── upgrade
├── CHANGELOG _ Hydejack.pdf
├── Documentation _ Hydejack.pdf
├── NOTICE _ Hydejack.pdf
├── PRO License _ Hydejack.pdf
├── PRO–hy-drawer License _ Hydejack.pdf
├── PRO–hy-push-state License _ Hydejack.pdf
├── icon.psd
├── sidebar-bg.psd
├── *-to-v7.5.0.diff
└── .ssh

install

Contains all files and folders needed to create a new blog.

upgrade

Contains only the files and folders needed for upgrading form an earlier version of Hydejack (6.0.0 or above). See the Upgrade for more.

CHANGELOG _ Hydejack.pdf

The changelog in PDF form.

Documentation _ Hydejack.pdf

This documentation in PDF form.

NOTICE _ Hydejack.pdf

The notice in PDF form.

PRO License _ Hydejack.pdf

The license for use of Hydejack PRO in PDF form.

PRO–hy-drawer License _ Hydejack.pdf

A license for use of hy-drawer as part of Hydejack PRO.

PRO–hy-push-state License _ Hydejack.pdf

A license for use of hy-push-state as part of Hydejack PRO.

icon.psd

A Photoshop template to help with generating the favicon, apple touch icon, etc.

sidebar-bg.psd

A Photoshop template for blurred sidebar backgrounds.

*-to-v7.5.0.diff

There will be multiple fo these files, where * is a previous version. They are git patches that you can apply to your repository via git-apply. Use these if you are using git and you are worried about accidentally overwriting changes you’ve made to Hydejack PRO. This is for advanced users.

.ssh

A hidden folder containing a SSH key for read-only access to the Hydejack PRO GitHub repository. You can use this to install Hydejack PRO as gem-based theme. See the installation instructions below. This is for advanced users.

For new installations only the install folder is interesting. Unzip the archive somewhere on your machine, then cd into the install folder, e.g.

$ cd ~/Downloads/hydejack-pro-7.5.0/install/

You can now continue with Running locally.

PRO via GitHub (advanced)

If you know how to handle SSH keys, you can also install the PRO version as a gem-based theme via GitHub. The advantage of this method is that you avoid cluttering your Jekyll repository with Hydejack’s source files.

The downloaded zip contains a read-only key for a private GitHub repository. It is located at <dowloaded zip>/.ssh/hydejack_pro_customers. You have to copy the key file to ~/.ssh (or wherever your SSH keys are located), e.g.:

$ cp ~/Downloads/hydejack-pro-v7.5.0/.ssh/hydejack_pro_customers ~/.ssh/

It is required that your private key files are NOT accessible by others, e.g.:

$ chmod 600 ~/.ssh/hydejack_pro_customers

Then add the following to .ssh/config:

Host hydejack
	HostName github.com
	IdentitiesOnly yes
	IdentityFile ~/.ssh/hydejack_pro_customers

Next, open Gemfile in your Jekyll repository and add:

gem "jekyll-theme-hydejack-pro", git: 'git@hydejack:qwtel/hydejack-pro.git', branch: 'gem-pro'

In your _config.yml, add:

theme: jekyll-theme-hydejack-pro

You can now continue with Running locally.

Running locally

Make sure you’ve cded into the directory where _config.yml is located. Before running for the first time, dependencies need to be fetched from RubyGems:

$ bundle install

NOTE: If you are missing the bundle command, you can install Bundler by running gem install bundler.

Now you can run Jekyll on your local machine:

$ bundle exec jekyll serve

and point your browser to http://localhost:4000 to see Hydejack in action.

Continue with Config