Installation & Setup

Using RubyGems

When installing the theme using RubyGems, demo images, posts, and pages are not included. Follow the instructions below for complete setup.

1. Build your site: bundle exec jekyll serve

Assuming there are no errors and the site is building properly, follow these steps next:

1. Create the following pages if they do not exist already (or change the extension of existing markdown files from .md to .html):

   • index.html - set to layout: home
   • posts/index.html - set to layout: page (you will also need to create a posts directory)

2. Configure the index.html front matter. Example:

   ---
   layout: home
   background: '/PATH_TO_IMAGE'
   ---

3. Configure the posts/index.html front matter. Example:

   ---
   layout: page
   title: Page Title
   description: This is the page description.
   background: '/PATH_TO_IMAGE'
   ---

4. For each post in the _posts directory, update the front matter. Example:

   ---
   layout: post
   title: "Post Title"
   subtitle: "This is the post subtitle."
   date: YYYY-MM-DD HH:MM:SS
   background: '/PATH_TO_IMAGE'
   ---

   For reference, look at the demo repository to see how the files are set up.

5. Build your site: bundle exec jekyll serve

Using Core Files

When using the core files, the demo images, posts, and pages are all included with the download. After following the instructions below, you can then go and change the content of the pages and posts.

1. Download or Clone the repository.

2. Update the following configuration settings in your _config.yml file:

   • baseurl
   • url
   • title
   • email (after setting this setting to a working email address, fill out the form on the contact page and send it - then check your email and verify the address and the form will send you messages when used)
   • description
   • author
   • twitter_username (Optional)
   • facebook_username (Optional)
   • github_username (Optional)
   • linkedin_username (Optional)
   • instagram_username (Optional)

3. Build your site: bundle exec jekyll serve