cycat-project-website/README.md

82 lines
2.7 KiB
Markdown
Raw Normal View History

2018-12-09 08:21:01 +01:00
# Jekyll Serif Theme
2018-12-10 01:18:14 +01:00
2020-08-23 12:44:27 +02:00
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.
2018-12-10 01:18:14 +01:00
2020-08-23 12:44:27 +02:00
[Live Demo](https://jekyll-serif-theme.netlify.app/) |
[Zerostatic Themes](https://www.zerostatic.io)
2018-12-10 01:18:14 +01:00
2020-08-23 12:44:27 +02:00
![Jekyll Serif Theme screenshot](https://github.com/JugglerX/jekyll-serif-theme/blob/master/screenshots/jekyll-serif-github-readme-screenshot.png)
2018-12-10 01:18:14 +01:00
## Theme features
2020-08-23 12:44:27 +02:00
- Jekyll 4
2018-12-10 01:18:14 +01:00
- Services (Collection)
- Team (Collection)
- Features (Data)
- SCSS
- Responsive design
2020-08-27 08:30:09 +02:00
- Bootstrap 4.3 grid and media queries only
2018-12-10 01:18:14 +01:00
- Responsive menu
- 100/100 Google Lighthouse speed score
2020-08-27 08:30:09 +02:00
- 100/100 Google Lighthouse seo score
- 100/100 Google Lighthouse accessibility score
- 100/100 Google Lighthouse best practices score
- Under 50KB without images or 80KB with images and illustrations ⚡
- Under 20KB without Google fonts ⚡⚡⚡
2018-12-10 01:18:14 +01:00
- Robust example content included
- Royalty free illustrations included
2020-08-27 08:30:09 +02:00
- Netlify & Github Pages ready
2020-08-27 08:23:31 +02:00
2020-01-17 08:33:39 +01:00
# Installation
2018-12-10 01:18:14 +01:00
2020-08-23 12:44:27 +02:00
### Installing Ruby & Jekyll
2020-08-23 05:57:25 +02:00
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.
2018-12-10 01:18:14 +01:00
2020-08-23 12:44:27 +02:00
### Installing Theme
2020-08-23 05:57:25 +02:00
2020-08-23 12:44:27 +02:00
Download or clone the theme.
2020-08-23 05:57:25 +02:00
2020-08-23 12:44:27 +02:00
To run the theme locally, navigate to the theme directory and run:
2020-08-23 05:57:25 +02:00
2020-08-23 12:44:27 +02:00
```
bundle install
```
2020-01-17 08:17:19 +01:00
2020-08-23 12:44:27 +02:00
To start the Jekyll local development server.
2020-01-17 08:17:19 +01:00
2020-08-23 12:44:27 +02:00
```
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)
2020-08-27 08:23:31 +02:00
## 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"`
2020-08-23 12:44:27 +02:00
## 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!