cycat-project-website/README.md

# Jekyll Serif Theme

Serif is a modern business theme for Jekyll. It contains multiple content types for a typical business website. The theme is fully responsive, blazing fast and artfully illustrated.

[Live Demo](https://jekyll-serif-theme.netlify.app/) | 
[Zerostatic Themes](https://www.zerostatic.io)

![Jekyll Serif Theme screenshot](https://github.com/JugglerX/jekyll-serif-theme/blob/master/screenshots/jekyll-serif-github-readme-screenshot.png)

## Theme features

- Jekyll 4
- Services (Collection)
- Team (Collection)
- Features (Data)
- SCSS
- Responsive design
- Bootstrap 4 grid and media queries only
- Responsive menu
- 100/100 Google Lighthouse speed score
- Under 30KB without images or 80KB with images and illustrations ⚡
- Robust example content included
- Royalty free illustrations included

[![Lighthouse Accessibility Badge](https://raw.githubusercontent.com/zerostaticthemes/jekyll-serif-theme/master/lighthouse/lighthouse_accessibility.svg)]
[![Lighthouse Best Practices Badge](https://raw.githubusercontent.com/zerostaticthemes/jekyll-serif-theme/master/lighthouse/lighthouse_best-practices.svg)]
[![Lighthouse Performance Badge](https://raw.githubusercontent.com/zerostaticthemes/jekyll-serif-theme/master/lighthouse/lighthouse_performance.svg)]
[![Lighthouse PWA Badge](https://raw.githubusercontent.com/zerostaticthemes/jekyll-serif-theme/master/lighthouse/lighthouse_pwa.svg)]
[![Lighthouse SEO Badge](https://raw.githubusercontent.com/zerostaticthemes/jekyll-serif-theme/master/lighthouse/lighthouse_seo.svg)]

# Installation

### Installing Ruby & Jekyll
 
If this is your first time using Jekyll, please follow the [Jekyll docs](https://jekyllrb.com/docs/installation/) and make sure your local environment (including Ruby) is setup correctly.

### Installing Theme

Download or clone the theme.

To run the theme locally, navigate to the theme directory and run:

```
bundle install
``` 

To start the Jekyll local development server.

```
bundle exec jekyll serve
``` 

To build the theme.
 
```
bundle exec jekyll build
```

# Deployment

## Netlify

This theme contains a `netlify.toml` and has been tested to work with Netlify.

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/zerostaticthemes/jekyll-serif-theme)

## Github Pages
This theme has been tested to work with Github Pages (and Github Project Pages)

If you are using this theme with Github Pages and you are using a Github Project Page then **your site will be hosted in a subfolder** you will need to update the `baseurl` in the `_config.yml` otherwise all the css, images and paths will be broken.

For example the site https://zerostaticthemes.github.io/jekyll-serif-theme would have `baseurl: "/jekyll-serif-theme"`


## Credits

- Beautiful royalty free Illustrations by Icons8 - https://icons8.com/illustrations/style--pixeltrue


## License

This theme is open source under the MIT license. If you fork or copy this theme you must leave me as the original author in the LICENSE file (on line 3 where I am listed as the author). Really, I just don't want people copying this theme and then saying it's their theme, because I put a lot of work into my themes, thanks!