diff --git a/README.md b/README.md index b0c6f5c..e2c7ac7 100755 --- a/README.md +++ b/README.md @@ -1,18 +1,17 @@ # 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. +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.com/) | -[Installation](#installation) | -[Zerostatic Themes](https://www.zerostatic.io/theme/hugo-hero/) +[Live Demo](https://jekyll-serif-theme.netlify.app/) | +[Zerostatic Themes](https://www.zerostatic.io) -![Hugo Serif Theme screenshot](https://github.com/JugglerX/jekyll-serif-theme/blob/master/screenshots/screenshot-with-border.png) +![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) -- Testimonials (Collection) - Features (Data) - SCSS - Responsive design @@ -25,18 +24,46 @@ Serif is a beautiful small business theme for Jekyll. It contains content types # Installation -## Installing Ruby & Ruby Gems +### 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 +### Installing Theme -To run the theme locally, navigate to the theme directory and run `bundle install` to install the dependencies, +Download or clone the theme. -Run run `jekyll serve` or `bundle exec jekyll serve` to start the Jekyll server. +To run the theme locally, navigate to the theme directory and run: -To build the theme run `jekyll build` or `bundle exec jekyll build` +``` +bundle install +``` -# License +To start the Jekyll local development server. -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. +``` +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) + + +## 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! diff --git a/_config.yml b/_config.yml index 4efb17c..8ae13d6 100755 --- a/_config.yml +++ b/_config.yml @@ -3,6 +3,16 @@ exclude: ['README.md'] permalink: pretty title: 'Jekyll Serif' +google_analytics_id: null +homepage: + show_call_box: true +logo: + mobile: "images/logo-mobile.svg" + desktop: "images/logo.svg" + desktop_height: "36px" +footer: + copyright_text: 'Free Jekyll theme by www.zerostatic.io' + collections: services: output: true @@ -25,18 +35,6 @@ defaults: sass: style: compact # possible values: nested expanded compact compressed -google_analytics_id: null - plugins: - jekyll-environment-variables -homepage: - show_call_box: true - -logo: - mobile: "images/logo-mobile.svg" - desktop: "images/logo.svg" - desktop_height: "36px" - -footer: - copyright_text: 'Free Jekyll theme by www.zerostatic.io' diff --git a/_data/social.json b/_data/social.json index 9056902..54e7600 100644 --- a/_data/social.json +++ b/_data/social.json @@ -1,7 +1,7 @@ [ { "name": "Github", - "link": "https://github.com/JugglerX/jekyll-serif-theme", + "link": "https://github.com/zerostaticthemes/jekyll-serif-theme", "image": "images/github.svg" }, { diff --git a/screenshots/jekyll-serif-github-readme-screenshot.png b/screenshots/jekyll-serif-github-readme-screenshot.png new file mode 100644 index 0000000..b71661a Binary files /dev/null and b/screenshots/jekyll-serif-github-readme-screenshot.png differ diff --git a/screenshots/screenshot-with-border.png b/screenshots/screenshot-with-border.png deleted file mode 100644 index 602b3a5..0000000 Binary files a/screenshots/screenshot-with-border.png and /dev/null differ diff --git a/screenshots/screenshot.png b/screenshots/screenshot.png index 38e7caa..4585e81 100644 Binary files a/screenshots/screenshot.png and b/screenshots/screenshot.png differ diff --git a/screenshots/tn.png b/screenshots/tn.png index 5239c9b..e067128 100644 Binary files a/screenshots/tn.png and b/screenshots/tn.png differ