Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/zerostaticthemes/hugo-serif-theme.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRobert Austin <rob@jugglerdigital.com>2021-06-27 05:56:38 +0300
committerGitHub <noreply@github.com>2021-06-27 05:56:38 +0300
commit86414da891351c3bb7e8d6d224dbac04e4ef1d04 (patch)
tree5767afa175e8c23046d6d1412218fef11b2a8b43 /README.md
parent4603a37f15a0e81bf139cb3e2b9205450617d413 (diff)
Update README.md
Diffstat (limited to 'README.md')
-rw-r--r--README.md81
1 files changed, 26 insertions, 55 deletions
diff --git a/README.md b/README.md
index f283782..9c8cce4 100644
--- a/README.md
+++ b/README.md
@@ -27,18 +27,13 @@ Serif is a modern business theme for Hugo. It contains content types for the arc
**SEO**
- 100/100 Google Lighthouse SEO score
+- 100/100 Google Lighthouse accessibility score
- Configure Google Analytics in `config.toml`
- Configure Google Analytics using env variable `HUGO_GOOGLE_ANALYTICS_ID` compatible with Netlify.
- Configure meta tags and OG meta tags for the homepage in `config.toml`
- Override any meta tags on a per page basis
- Semantic HTML document structure
-**Accessibility**
-- 100/100 Google Lighthouse accessibility score
-- Accessible colors, headings and link text (by design)
-- Attention has been paid to using correct contrast, font sizes etc
-- Attention has been paid to ensuring comfortable hit zones and link sizing on mobile
-
**Menu**
- Responsive menu managed in `config.toml`
- Animated hamburger menu on mobile
@@ -47,7 +42,7 @@ Serif is a modern business theme for Hugo. It contains content types for the arc
- Robust example content included
- Royalty free illustrations included
-**Templating**
+**Code**
- No hardcoded content in the layouts
- Plenty of examples of using `range` and `where` to loop over various sections/content types
- Examples of `range` by Param
@@ -57,64 +52,42 @@ Serif is a modern business theme for Hugo. It contains content types for the arc
- Set `body` classes from individual layouts - useful for CSS styling.
- Example of using Hugo custom `layout` for the contact page
+## Installation
-# Installation
-
-## Hugo Install
-
-To use this theme you will need to have Hugo installed. If you don't already have Hugo installed please follow the official [installation guide](https://gohugo.io/getting-started/installing/)
-
-### Check Hugo version (Hugo Extended is required!)
+**1. Install Hugo**
-This theme uses [Hugo Pipes](https://gohugo.io/hugo-pipes/scss-sass/) to compile SCSS and minify assets. Please make sure you have the **Hugo Extended** version installed. If you are not using the extended version this theme will not work.
+To use this theme you will first need to have Hugo installed. Please follow the official [installation guide](https://gohugo.io/getting-started/installing/)
-To check your version of Hugo, run:
+⚠️ **Note:** Check your Hugo version - **Hugo Extended** is required!
-```
-hugo version
-```
-
-This will output the currently installed version of Hugo. Make sure you see `/extended` after the version number, for example `Hugo Static Site Generator v0.51/extended darwin/amd64 BuildDate: unknown` You do not need to use version v0.51 specifically, it just needs to have the `/extended` part
+This theme uses [Hugo Pipes](https://gohugo.io/hugo-pipes/scss-sass/) to compile SCSS and minify assets which means if you not using the Hugo extended version this theme will not work. To check your version of Hugo, run `hugo version`. Make sure you see __/extended__ after the version number, for example _Hugo Static Site Generator v0.51/extended darwin/amd64 BuildDate: unknown_ You do not need to use version v0.51 specifically, it just needs to have the _/extended_ part.
+**2. Create a new Hugo site**
-## Theme Install
-
-### Create a new Hugo site
+This will create a fresh Hugo site in the folder `mynewsite`.
```
hugo new site mynewsite
```
-This will create a fresh Hugo site in the folder `mynewsite`.
-
-### Install theme
-
-Copy or git clone this theme into the sites themes folder `mynewsite/themes`
+**3. Install the theme**
-#### Install with Git
+Download or git clone this theme into the sites themes folder `mynewsite/themes`. You should end up with the following folder structure `mynewsite/themes/hugo-serif-theme`
```
cd mynewsite
-git clone https://github.com/jugglerx/hugo-serif-theme.git themes/hugo-serif-theme
+git clone https://github.com/zerostaticthemes/hugo-serif-theme.git themes/hugo-serif-theme
```
-#### Install from .zip file
-
-You can download the .zip file located here https://github.com/zerostaticthemes/hugo-serif-theme/archive/master.zip.
-
-Extract the downloaded .zip inside the `themes` folder. Rename the extracted folder from `hugo-serif-theme-master` -> `hugo-serif-theme`. You should end up with the following folder structure `mynewsite/themes/hugo-serif-theme`
-
-### Add example content
-
-Copy the entire contents of the `mynewsite/themes/hugo-serif-theme/exampleSite/` folder to root folder of your Hugo site, ie `mynewsite/`
+**4. Copy the example content**
-To copy the files using terminal, make sure you are still in the projects root, ie the `mynewsite` folder.
+Copy the entire contents of the `mynewsite/themes/hugo-serif-theme/exampleSite/` folder to root folder of your Hugo site, ie `mynewsite/`. To copy the files using terminal, make sure you are still in the projects root, ie the `mynewsite` folder.
```
cp -a themes/hugo-serif-theme/exampleSite/. .
```
-### Update config.toml
+**5. Update config.toml**
After you copy the `config.toml` into the root folder of your Hugo site you will need to update the `baseURL`, `themesDir` and `theme` values in `mynewsite/config.toml`
@@ -124,7 +97,7 @@ themesDir = "themes"
theme = "hugo-serif-theme"
```
-### Run Hugo
+**6. Run Hugo**
After installing the theme for the first time, generate the Hugo site.
@@ -142,21 +115,23 @@ hugo server
Now enter [`localhost:1313`](http://localhost:1313) in the address bar of your browser.
-# Deployment
-## Stackbit
+## 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/hugo-serif-theme)
-## Netlify
+### 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/hugo-serif-theme)
-# Configuring Theme
+
+## Configuring Theme
### Google Analytics
@@ -201,14 +176,10 @@ You can set meta tags on a per template basis using a block. For example, you mi
{{ end }}
```
-## Credits
-
-- Beautiful royalty free Illustrations by Icons8 - https://icons8.com/illustrations/style--pixeltrue
-
+## License & Credits
-## License
+This theme is open source under the MIT license.
-This theme is open source under the MIT license. Please be respectful 🙏🏽
+Please don't create ports of this theme without asking me. Yes this theme is open-source but I've had several people "port" this theme (with only minor changes) and then advertise the theme as their own. Then they don't update it and it starts to get old and break etc. Now lots of people are finding these old crappy versions of the theme.
-* If you fork or copy this theme please leave me as an original author in the LICENSE file on line 3 where I am listed as the author.
-* Please don't create ports of this theme without at least asking me. Yes this theme is open-source but I've had several people "port" this theme (with only minor changes) and then advertise the theme as their own. Then they don't update it and it starts to get old and break etc. Now lots of people are finding these old crappy versions of the theme.
+- Beautiful royalty free Illustrations by Icons8 - https://icons8.com/illustrations/style--pixeltrue