Prerequisites #

Follow the instructions in jekyll Docs to install Ruby, RubyGems, and Bundler. You may also install Git

Installation #

Creating a new site #

1. Using RubyGems - Easy to upgrade, but it is not convenient with customizing the Theme.

2. Forking using Github - Not easy to upgrade, but you needs familiar with Jekyll, Git or Github.

Option 1. Using RubyGems #

Copy the Gemfile gem 'jekyll-theme-fica', '~> 0.2.0', paste it on the Gemfile file then run

1
$ bin/run insdep

or

1
$ bundle install

and run

1
$ bin/run server

or

1
$ bundle exec jekyll serve

Option 2. Forking Github #

name it <GH_USERNAME>.github.io, where GH_USERNAME represents your GitHub username.

then run:

1
$ bin/run insdep

and run

1
$ bin/run server

Usage #

Configuration #

Before publishing the site to github-pages, replace the varable of baseurl. If you have brought a doman remove the varable in the _config.yml file baseurl: /jekyll-fica-theme

Fica Theme will respect the following variables, in your _config.yml file:

1
2
3
4
5
6
7
8
title: [The title of your site]
description: [A short description of your site's purpose]

socials:
  # Change aeziyehl to your full name.
  name: [The auther of the site]
  # it also be the copyright owner's link
  author-link: [Link of the auther]

Change the links of your site header:

1
2
3
4
5
6
7
8
9
10
11
12
header:
    external_link_1: true # if false, it adds the baseurl of the site
    header_name_1: Download
    header_link_1: https://github.com/aeziyehl/jekyll-theme-fica/zipball/master

    external_link_2: false # if false, it adds the baseurl of the site
    header_name_2: Post
    header_link_2: /Post/
    
    external_link_3: false # if false, it adds the baseurl of the site
    header_name_3: About
    header_link_3: /About/

Change the links of your site header:

If you want to create a external link in the headers Links remove /jekyll-theme-fica on _includes/Header/html BELLOW

1
2
3
4
5
6
7
8
9
10
11
12
13
header:
    external_link_1: true # if false, it adds the baseurl of the site
    header_name_1: Download
    header_link_1: https://github.com/aeziyehl/jekyll-theme-fica/zipball/master
-   external_link_2: false # if false, it adds the baseurl of the site
+   external_link_2: true # if false, it adds the baseurl of the site
    header_name_2: Post
    header_link_2: /Post/
    
-   external_link_3: false # if false, it adds the baseurl of the site
+   external_link_3: true # if false, it adds the baseurl of the site
    header_name_3: About
    header_link_3: /About/

Upgrading #

Depending on how you use the theme:

• if you are using the theme gem. Run:

1
$ bin/run upgrade

Please refer to the Upgrade Guide to keep your repo’s files in sync with the latest version of the theme.

• If you forked it on GitHub, then merge the latest tags into your Jekyll site to complete the upgrade. The merge is likely to conflict with your local modifications. Please be patient and careful to resolve these conflicts.