You can preview the theme to [see what it looks like](https://involts.github.io/jekyll-theme-fica/) or [download it today !](https://github.com/Involts/jekyll-theme-fica/zipball/master) [![Gem Version](https://badge.fury.io/rb/jekyll-theme-fica.svg)](https://badge.fury.io/rb/jekyll-theme-fica) ## Installation and first use Add this line to your Jekyll site's `Gemfile`: ```ruby gem "jekyll-theme-fica" ``` And add this line to your Jekyll site's `_config.yml`: ```yaml theme: jekyll-theme-fica ``` to install all the dependencies: $ script/bootstrap and run, to run your jekyll site: $ script/build ## Note: Before publishing the site to github-pages, replace the varable of baseurl: if you have brought a doman remove the varable below: ``` # _config.yml baseurl: [Your Repository Name] ``` If you want to create a external link in the headers Links remove `{{site.baseurl}}` on `_includes/Header.html`: Before: ```
{{site.header.header_name_1}} {{site.header.header_name_2}} {{site.header.header_name_3}}
``` After: ```
{{site.header.header_name_1}} {{site.header.header_name_2}} {{site.header.header_name_3}}
``` # Customizations ## Customizing '_config.yml' Fica Theme will respect the following variables, in your '_config.yml' file: ``` title: [The title of your site] author: [The auther of the site] name: [The owner of the site] description: [A short description of your site's purpose] ``` Change the links of your site header: ``` header: header_name_1: Download header_link_1: https://github.com/Involts/jekyll-theme-fica/zipball/master header_name_2: Post header_link_2: /Post/ header_name_3: About header_link_3: /About/ ``` ## Customizing the Styles, Vriables and Color Scheme: if you like to override the default styles of the theme, go to '_sass/Custom-Styles.scss'. if you like to override the default Variables of the theme, go to '_sass/Custom-Variable.scss'. if you like to change the colors of the site, go to '_sass/Color_scheme.scss'. ## How to replace the logo on the header ? Replace logo.png at the top of your site. Make sure that the logo is 16x16 px to avoid overlapping the title. ## how to replace the pictue at the homepage ? Replace 'assets/img/fica_ad.png'. # Customizing Google Analytics code Google has released several iterations to their Google Analytics code over the years since this theme was first created. If you would like to take advantage of the latest code, paste it into _includes/Google-Analytics.html in your Jekyll site. ## Contributing Interested in contributing to Fica Theme? We'd love your help. Fica Theme is an open source project, built one contribution at a time by users like you. See [the contributing file](docs/contributing.md) for instructions on how to contribute. ### Previewing the theme locally If you'd like to preview the theme locally (for example, in the process of proposing a change): 1. Clone down the theme's repository (`git clone https://github.com/Involts/jekyll-theme-fica`) 2. `cd` into the theme's directory 3. Run `script/bootstrap` to install the necessary dependencies 4. Run `script/bootstrap` to start the preview server 5. Visit [`localhost:4000`](http://localhost:4000) or [`localhost:4000/jekyll-theme-fica`](http://localhost:4000/jekyll-theme-fica) in your browser to preview the theme ### Running tests The theme contains a minimal test suite, to ensure a site with the theme would build successfully. To run the tests, simply run `script/build`. You'll need to run `script/bootstrap` once before the test script will work. ## License The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).