cycat-project-website/README.md

3.2 KiB
Executable File

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 | Zerostatic Themes

Jekyll Serif Theme screenshot

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] [Lighthouse Best Practices Badge] [Lighthouse Performance Badge] [Lighthouse PWA Badge] [Lighthouse SEO Badge]

Installation

Installing Ruby & Jekyll

If this is your first time using Jekyll, please follow the Jekyll docs 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

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

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!