update readme with extra instructions for using hugo extended

This commit is contained in:
Robert Austin 2019-07-23 10:52:34 +10:00
parent d381ea22ca
commit 2e1cee539f

View file

@ -47,14 +47,18 @@ Whisper is a minimal documentation theme built for Hugo. The design and function
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
### Check Hugo version (Hugo 0.51+ 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 not compile.
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
```