cycat-project-website/README.md

43 lines
1.7 KiB
Markdown
Executable File

# Jekyll Serif Theme
Serif is a beautiful small business theme for Jekyll. It contains content types for the archetypical small business website. The theme is fully responsive, blazing fast and artfully illustrated.
[Live Demo](https://jekyll-serif-theme.netlify.com/) |
[Installation](#installation) |
[Zerostatic Themes](https://www.zerostatic.io/theme/hugo-hero/)
![Hugo Serif Theme screenshot](https://github.com/JugglerX/jekyll-serif-theme/blob/master/screenshots/screenshot-with-border.png)
## Theme features
- Services (Collection)
- Team (Collection)
- Testimonials (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
# Installation
## Installing Ruby & Ruby Gems
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
To run the theme locally, navigate to the theme directory and run `bundle install` to install the dependencies,
Run run `jekyll serve` or `bundle exec jekyll serve` to start the Jekyll server.
To build the theme run `jekyll build` or `bundle exec jekyll build`
# License
If you fork or copy this theme the LICENSE file and the copyright notice on line 3 (where I am listed as the author) must not be changed. You cannot just replace the copyright line with your own name. Attribution in your README.md or on your site is also welcome but not required.