This theme generates documentation from markdown files located in content/docs
The “Home” page is not documentation, it can be used to introduce your project etc.
SCSS (Hugo Pipelines)
100/100 Google Lighthouse speed score
21KB without images ⚡
Vanilla JS only
Responsive mobile menu managed in config.toml
1. Install Hugo
To use this theme you will first need to have Hugo installed. Please follow the official installation guide
⚠️ Note: Check your Hugo version - Hugo Extended is required!
This theme uses Hugo Pipes 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
This will create a fresh Hugo site in the folder mynewsite.
hugo new site mynewsite
3. Install the theme
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-whisper-theme
git clone https://github.com/zerostaticthemes/hugo-whisper-theme.git themes/hugo-whisper-theme
4. Copy the example content
Copy the entire contents of the mynewsite/themes/hugo-whisper-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-whisper-theme/exampleSite/. .
6. Run Hugo
After installing the theme for the first time, generate the Hugo site.
You run this command from the root folder of your Hugo site ie mynewsite/
For local development run Hugo’s built-in local server.
This theme includes a netlify.toml which is configured to deploy to Netlify from the exampleSite folder. If you have installed this theme into a new Hugo site and the exampleSite folder was copied or removed, you should delete the netlify.toml file.