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>2020-09-13 08:58:02 +0300
committerRobert Austin <rob@jugglerdigital.com>2020-09-13 08:58:02 +0300
commite2837e4ae002c8b31475f2333bcd2a53360ed2d4 (patch)
tree2ac8821a9f542d04f440d39286e19a06e72718ed /README.md
parenta3f21548d8ccf70a1fd01eafa9b8ba18d78bf29e (diff)
remove exampleSite
Diffstat (limited to 'README.md')
-rw-r--r--README.md74
1 files changed, 17 insertions, 57 deletions
diff --git a/README.md b/README.md
index 7f0d5c0..174c183 100644
--- a/README.md
+++ b/README.md
@@ -65,20 +65,15 @@ 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
-# Stackbit Deploy
-Use Stackbit to deploy this theme to Netlify and connect any headless CMS _(Forestry, NetlifyCMS, Sanity, Contentful, DatoCMS)_ - Actually really amazing.
-
-[![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)
-
-# Installation
+# Hugo Installation
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 0.51+ Extended is required)
+### Check Hugo version (Hugo Extended is required!)
-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 not compile.
+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 check your version of Hugo, run:
@@ -86,72 +81,36 @@ To check your version of Hugo, run:
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, you can use any version of Hugo above 0.51. It just needs to have the `/extended` part
-
-### Create a new Hugo site
-
-```
-hugo new site mynewsite
-```
-
-This will create a fresh Hugo site in the folder `mynewsite`.
+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
-### Install theme
-Copy or git clone this theme into the sites themes folder `mynewsite/themes`
+# Theme Installation
-#### Install with Git
+Download, fork or clone this repo, it's ready to go.
```
-cd mynewsite
-git clone https://github.com/jugglerx/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/`
-
-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/. .
+hugo
```
-### 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`
-
```
-baseURL = "/"
-themesDir = "themes"
-theme = "hugo-serif-theme"
+hugo server
```
-### Run Hugo
+# Deployment
-After installing the theme for the first time, generate the Hugo site.
+## Stackbit
-You run this command from the root folder of your Hugo site ie `mynewsite/`
+Use Stackbit to deploy this theme and connect any headless CMS _(Forestry, NetlifyCMS, Sanity, Contentful, DatoCMS)_ - It's actually really amazing. This theme contains a valid and tested `stackbit.yaml`
-```
-hugo
-```
+[![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)
-For local development run Hugo's built-in local server.
+## Netlify
-```
-hugo server
-```
+Use Netlify to deploy this theme. This theme contains a valid and tested `netlify.toml` - Feel free to use the 1-click deploy below.
-Now enter [`localhost:1313`](http://localhost:1313) in the address bar of your browser.
+[![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 features
+# Configuring Theme
Copy your Google Analytics id into the `config.toml` - Also supports Google Tag Manager.
@@ -201,6 +160,7 @@ You can set meta tags on a per template basis using a block. For example, you mi
- 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!