Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
JugglerX committed Aug 27, 2020
1 parent c717c47 commit 1c2c670
Show file tree
Hide file tree
Showing 9 changed files with 7,599 additions and 2 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,12 @@ Serif is a modern business theme for Jekyll. It contains multiple content types
- Robust example content included
- Royalty free illustrations included

[![Lighthouse Accessibility Badge](https://raw.githubusercontent.com/zerostaticthemes/jekyll-serif-theme/master/lighthouse/lighthouse_accessibility.svg)]
[![Lighthouse Best Practices Badge](https://raw.githubusercontent.com/zerostaticthemes/jekyll-serif-theme/master/lighthouse/lighthouse_best-practices.svg)]
[![Lighthouse Performance Badge](https://raw.githubusercontent.com/zerostaticthemes/jekyll-serif-theme/master/lighthouse/lighthouse_performance.svg)]
[![Lighthouse PWA Badge](https://raw.githubusercontent.com/zerostaticthemes/jekyll-serif-theme/master/lighthouse/lighthouse_pwa.svg)]
[![Lighthouse SEO Badge](https://raw.githubusercontent.com/zerostaticthemes/jekyll-serif-theme/master/lighthouse/lighthouse_seo.svg)]

# Installation

### Installing Ruby & Jekyll
Expand Down Expand Up @@ -58,6 +64,13 @@ 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)

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

Expand Down
5 changes: 3 additions & 2 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
baseurl: '/jekyll-serif-theme'
baseurl: ''
exclude: ['README.md']
permalink: pretty
title: 'Jekyll Serif'
Expand All @@ -14,9 +14,10 @@ footer:
copyright_text: 'Free Jekyll theme by <a class="zerostatic" href="https://www.zerostatic.io">www.zerostatic.io</a>'

seo:
meta_og_title: "Jekyll Serif Theme"
meta_og_type: "website"
meta_og_url: "https://jekyll-serif-theme.netlify.app"
meta_og_image: "https://raw.githubusercontent.com/JugglerX/jekyll-serif-theme/master/images/tn.png"
meta_og_image: "https://raw.githubusercontent.com/zerostaticthemes/jekyll-serif-theme/master/screenshots/tn.png"
meta_og_description: "Jekyll Serif is a modern business theme for Hugo. It contains content types for the archetypical business website. The theme is fully responsive, blazing fast and artfully illustrated."
meta_twitter_card: "summary"
meta_twitter_site: "@zerostaticio"
Expand Down
5 changes: 5 additions & 0 deletions _sass/components/_call.scss
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,11 @@
.call-phone {
margin-bottom: 5px;
}
.call-email {
a {
color: $black;
}
}
strong {
font-weight: bold;
}
Expand Down
7,573 changes: 7,573 additions & 0 deletions lighthouse/jekyll_serif_theme_netlify_app.html

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions lighthouse/lighthouse_accessibility.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions lighthouse/lighthouse_best-practices.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions lighthouse/lighthouse_performance.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions lighthouse/lighthouse_pwa.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions lighthouse/lighthouse_seo.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 1c2c670

Please sign in to comment.