orange

orange

A jekyll theme with portfolio support, contact form and blog

Note: This project is not currently being actively maintained.

Thank you for using the code and if you'd like to be a maintainer please contact me

Orange

Orange, an open source and free minimal Jekyll theme. It is a product of my attempt at learning Jekyll. This guide will help you get started with the theme's basic customization and settings.

Table of contents

1. [Dependencies](#dependencies) 2. [Installation](#installation) 3. [Configuration](#configuration) 1. [_config.yml](#configyml) 4. [Updates](#updates)

1. Dependencies

2. Installation

  • To install the theme clone the repository git clone https://github.com/talentedunicorn/orange.git
  • Copy config.sample.yml to _config.yml
  • Open _config.yml and set up the necessary information
  • Open your terminal program and inside the folder run jekyll serve

3. Configuration

Orange comes with a few configuration files each with their own usage

3.1 _config.yml

This is the main configuration file. Edit these sections:

  • title: This appears on your metadata and is part of your title tag
  • description: This is part of your metatag, keep it under 150 characters for SEO
  • avatar_path: The path to your avatar image
  • url: Your hosting url. Change this to your hosting url e.g. http://[your_name].github.io OR http://localhost:4000 when running on localhost
  • Feature settings
    • tagManagerID: Orange has analytics support through Google tag manager. Add your container id from tag manager here.
    • disqus_shortname: Comment support is through Disqus. Create an account here and add your shortname here.
    • formpost: A URL where your contact form will post to. If you need a free form post service try formspree.io

4. Updates

Updates to the theme will be available by tracking this repository's master branch. To do so;

  • create a new branch e.g. git branch theme
  • Add the theme's remote e.g. git remote add orange git@github.com:talentedunicorn/orange.git
  • Set the branch to track the master branch i.e. git branch theme --set-upstream-to=orange/master
  1. For development and optimizing images