hswro_org/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.netlify.app/) | 
[Zerostatic Themes](https://www.zerostatic.io)

![Jekyll Serif Theme screenshot](https://www.zerostatic.io/theme/jekyll-serif/jekyll-serif-screenshot.png)

### Theme features

- Jekyll 4.1
- Services (Collection)
- Team (Collection)
- Features (Data)
- SCSS
- Responsive design
- Bootstrap 4.3 grid and media queries only
- Responsive menu
- 100/100 Google Lighthouse speed score
- 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 ⚡⚡⚡
- Robust example content included
- Royalty free illustrations included
- Netlify & Github Pages ready

## 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

### Stackbit

Use Stackbit to deploy this theme. This theme contains a valid and tested `stackbit.yaml`

[![Create with Stackbit](https://assets.stackbit.com/badge/create-with-stackbit.svg)](https://app.stackbit.com/create?theme=https://github.com/zerostaticthemes/jekyll-serif-theme)

### Netlify

Use Netlify to deploy this theme. This theme contains a valid and tested `netlify.toml` - Feel free to use the 1-click deploy below.

[![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). When using Github Pages 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/"`

## License & Credits

### Credits

- Beautiful royalty free Illustrations by Icons8 - https://icons8.com/illustrations/style--pixeltrue
- Stock images by Unsplash - https://unsplash.com/
- Feature icons by Noun Project - https://thenounproject.com/

### License

This theme is open source under the MIT license. Please be respectful 🙏🏽 Leave me as an original author in the LICENSE file if you fork or copy this theme. 

> Do not create ports of this theme. Do You can't re-distribute or re-sell this theme as a theme, stock, in a tool or as a template.

### Other Versions

- [Hugo Serif Theme](https://github.com/zerostaticthemes/hugo-serif-theme) (official)
- [Gatsby Serif Theme](https://github.com/zerostaticthemes/gatsby-serif-theme) (official)
first commit 2018-12-09 07:21:01 +00:00			`# Jekyll Serif Theme`
readme and screenshots 2018-12-10 00:18:14 +00:00
clean up readme 2020-08-23 10:44:27 +00: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.`
readme and screenshots 2018-12-10 00:18:14 +00:00
update live demo link 2020-09-05 05:12:09 +00:00			`[Live Demo](https://jekyll-serif.netlify.app/) \|`
clean up readme 2020-08-23 10:44:27 +00:00			`[Zerostatic Themes](https://www.zerostatic.io)`
readme and screenshots 2018-12-10 00:18:14 +00:00
Update README.md 2020-09-05 05:46:55 +00:00			`![Jekyll Serif Theme screenshot](https://www.zerostatic.io/theme/jekyll-serif/jekyll-serif-screenshot.png)`
readme and screenshots 2018-12-10 00:18:14 +00:00
Update README.md 2021-03-09 06:53:32 +00:00			`### Theme features`
readme and screenshots 2018-12-10 00:18:14 +00:00
Update README.md 2020-09-05 05:46:55 +00:00			`- Jekyll 4.1`
readme and screenshots 2018-12-10 00:18:14 +00:00			`- Services (Collection)`
			`- Team (Collection)`
			`- Features (Data)`
			`- SCSS`
			`- Responsive design`
update readme 2020-08-27 06:30:09 +00:00			`- Bootstrap 4.3 grid and media queries only`
readme and screenshots 2018-12-10 00:18:14 +00:00			`- Responsive menu`
			`- 100/100 Google Lighthouse speed score`
update readme 2020-08-27 06:30:09 +00: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 ⚡⚡⚡`
readme and screenshots 2018-12-10 00:18:14 +00:00			`- Robust example content included`
			`- Royalty free illustrations included`
update readme 2020-08-27 06:30:09 +00:00			`- Netlify & Github Pages ready`
update readme 2020-08-27 06:23:31 +00:00
Update README.md 2021-03-09 06:53:32 +00:00			`## Installation`
readme and screenshots 2018-12-10 00:18:14 +00:00
clean up readme 2020-08-23 10:44:27 +00:00			`### Installing Ruby & Jekyll`
update to jekyll 4 2020-08-23 03:57:25 +00: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.`
readme and screenshots 2018-12-10 00:18:14 +00:00
clean up readme 2020-08-23 10:44:27 +00:00			`### Installing Theme`
update to jekyll 4 2020-08-23 03:57:25 +00:00
clean up readme 2020-08-23 10:44:27 +00:00			`Download or clone the theme.`
update to jekyll 4 2020-08-23 03:57:25 +00:00
clean up readme 2020-08-23 10:44:27 +00:00			`To run the theme locally, navigate to the theme directory and run:`
update to jekyll 4 2020-08-23 03:57:25 +00:00
clean up readme 2020-08-23 10:44:27 +00:00			```
			`bundle install`
			```
Update README.md 2020-01-17 07:17:19 +00:00
clean up readme 2020-08-23 10:44:27 +00:00			`To start the Jekyll local development server.`
Update README.md 2020-01-17 07:17:19 +00:00
clean up readme 2020-08-23 10:44:27 +00:00			```
			`bundle exec jekyll serve`
			```

			`To build the theme.`

			```
			`bundle exec jekyll build`
			```

Update README.md 2021-03-09 06:53:32 +00:00			`## Deployment`
clean up readme 2020-08-23 10:44:27 +00:00
Update README.md 2021-03-09 06:53:32 +00:00			`### Stackbit`
update readme 2021-03-09 06:50:31 +00:00
			Use Stackbit to deploy this theme. This theme contains a valid and tested `stackbit.yaml`

			`[![Create with Stackbit](https://assets.stackbit.com/badge/create-with-stackbit.svg)](https://app.stackbit.com/create?theme=https://github.com/zerostaticthemes/jekyll-serif-theme)`

Update README.md 2021-03-09 06:53:32 +00:00			`### Netlify`
clean up readme 2020-08-23 10:44:27 +00:00
update readme 2021-03-09 06:50:31 +00:00			Use Netlify to deploy this theme. This theme contains a valid and tested `netlify.toml` - Feel free to use the 1-click deploy below.
clean up readme 2020-08-23 10:44:27 +00:00
			`[![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)`

Update README.md 2021-03-09 06:53:32 +00:00			`### Github Pages`
update readme 2021-03-09 06:50:31 +00:00			This theme has been tested to work with Github Pages (and Github Project Pages). When using Github Pages you will need to update the `baseurl` in the `_config.yml` otherwise all the css, images and paths will be broken.
update readme 2020-08-27 06:23:31 +00:00
testing gh-pages baseurl 2021-03-09 03:53:24 +00:00			For example the site https://zerostaticthemes.github.io/jekyll-serif-theme would have `baseurl: "/jekyll-serif-theme/"`
update readme 2020-08-27 06:23:31 +00:00
update seo, update page layouts css, update stackbit.yaml 2021-07-12 03:06:45 +00:00			`## License & Credits`
clean up readme 2020-08-23 10:44:27 +00:00
Update README.md 2021-03-09 06:53:32 +00:00			`### Credits`
clean up readme 2020-08-23 10:44:27 +00:00
			`- Beautiful royalty free Illustrations by Icons8 - https://icons8.com/illustrations/style--pixeltrue`
update seo, update page layouts css, update stackbit.yaml 2021-07-12 03:06:45 +00:00			`- Stock images by Unsplash - https://unsplash.com/`
			`- Feature icons by Noun Project - https://thenounproject.com/`
clean up readme 2020-08-23 10:44:27 +00:00
Update README.md 2021-03-09 06:53:32 +00:00			`### License`
clean up readme 2020-08-23 10:44:27 +00:00
update seo, update page layouts css, update stackbit.yaml 2021-07-12 03:06:45 +00:00			`This theme is open source under the MIT license. Please be respectful 🙏🏽 Leave me as an original author in the LICENSE file if you fork or copy this theme.`
update readme 2021-03-09 06:50:31 +00:00
update seo, update page layouts css, update stackbit.yaml 2021-07-12 03:06:45 +00:00			`> Do not create ports of this theme. Do You can't re-distribute or re-sell this theme as a theme, stock, in a tool or as a template.`

			`### Other Versions`

			`- [Hugo Serif Theme](https://github.com/zerostaticthemes/hugo-serif-theme) (official)`
			`- [Gatsby Serif Theme](https://github.com/zerostaticthemes/gatsby-serif-theme) (official)`