Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/zerostaticthemes/hugo-whisper-theme
Whisper is a minimal documentation theme for Hugo.
https://github.com/zerostaticthemes/hugo-whisper-theme
hugo hugo-site hugo-theme jamstack static-site-generator
Last synced: 23 days ago
JSON representation
Whisper is a minimal documentation theme for Hugo.
- Host: GitHub
- URL: https://github.com/zerostaticthemes/hugo-whisper-theme
- Owner: zerostaticthemes
- License: mit
- Created: 2019-02-17T06:32:03.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-03-14T18:06:09.000Z (8 months ago)
- Last Synced: 2024-09-28T05:41:09.232Z (about 1 month ago)
- Topics: hugo, hugo-site, hugo-theme, jamstack, static-site-generator
- Language: SCSS
- Homepage: https://hugo-whisper.netlify.com
- Size: 2.2 MB
- Stars: 265
- Watchers: 7
- Forks: 126
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-repositories - zerostaticthemes/hugo-whisper-theme - Whisper is a minimal documentation theme for Hugo. (SCSS)
README
# Hugo Whisper Theme
Whisper is a minimal documentation theme built for Hugo. The design and functionality is intentionally minimal.
[Live Demo](https://hugo-whisper.netlify.app/) |
[Zerostatic Themes](https://www.zerostatic.io/)
## Theme features
**Content Types**
- Docs (Markdown)
- Homepage
**Content Management**
- 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**
- SCSS (Hugo Pipelines)
- Responsive design
- Bootstrap 5.3
**Speed**
- 100/100 Google Lighthouse speed score
- 21KB without images ⚡
- Vanilla JS only
**Menu**
- Responsive mobile menu managed in `config.toml`
## Installation
**1. Install Hugo**
To use this theme you will first need to have Hugo installed. Please follow the official [installation guide](https://gohugo.io/getting-started/installing/)
⚠️ **Note:** Check your Hugo version - **Hugo Extended** is required!
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**
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`
```
cd mynewsite
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/`
```
hugo
```
For local development run Hugo's built-in local server.
```
hugo server
```
Now enter [`localhost:1313`](http://localhost:1313) in the address bar of your browser.
## Deploying to Netlify
[](https://app.netlify.com/start/deploy?repository=https://github.com/zerostaticthemes/hugo-whisper-theme)
This theme includes a `netlify.toml` which is [configured to deploy to Netlify](https://discourse.gohugo.io/t/deploy-your-theme-to-netlify/15508) 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.
## Credits
**More Hugo Themes by Zerostatic**
- [Hugo Hero](https://github.com/zerostaticthemes/hugo-hero-theme) - Open-source business theme
- [Hugo Whisper](https://github.com/zerostaticthemes/hugo-whisper-theme) - Open-source documentation theme
- [Hugo Serif](https://github.com/zerostaticthemes/hugo-serif-theme) - Open-source business theme
- [Hugo Winston](https://github.com/zerostaticthemes/hugo-winston-theme) - Open-source blog theme
- [Hugo Advance](https://www.zerostatic.io/theme/hugo-advance/) - Premium advanced multi page business & marketing theme
- [Hugo Paradigm](https://www.zerostatic.io/theme/hugo-paradigm/) - Premium landing page + site builder theme
- [Hugo Lever](https://www.zerostatic.io/theme/hugo-lever/) - Premium personal / bio theme
- [Hugo Shard](https://www.zerostatic.io/theme/hugo-lever/) - Premium SAAS / landing page theme
**Find hundreds more Hugo themes on Built At Lightspeed**
[
](https://builtatlightspeed.com/category/hugo)