hugo-whisper-theme

KO | EN

gitlite — search

#python #hacktoberfest #ai #llm #go #rust #deep-learning #nodejs #java #awesome #cli #vue #security #ios

hugo-whisper-theme

(★ 273)

Whisper is a minimal documentation theme for Hugo.

파일 탐색기

최종 버전 다운로드 (.zip)

- default.md
- - scripts.js
- - _bootstrap-variables.scss
  - style.scss
- - default.md
  - docs.md
- - _index.md
- - social.json
- - favicon.png
- .hugo_build.lock
- config.toml
- screenshot.png
- tn.png
- - baseof.html
  - list.html
  - single.html
  - summary.html
- - google-analytics.html
  - hamburger.html
  - header.html
  - main-menu-mobile.html
  - main-menu.html
  - sidebar.html
  - social.html
  - sub-footer.html
- 404.html
- index.html
- - logo-mobile.svg
  - logo.svg
  - terminal.gif
.gitignore
.hugo_build.lock
LICENSE
netlify.toml
README.md
theme.toml

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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/)

![Hugo Whisper Theme screenshot](https://www.zerostatic.io/theme/hugo-whisper/hugo-whisper-screenshot.png)

## 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

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](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**

[<img alt="Built At Lightspeed Hugo themes directory screenshot" width="400px" src="https://www.zerostatic.io/images/builtatlightspeed-hugo-themes.jpg" />](https://builtatlightspeed.com/category/hugo)

hugo-whisper-theme

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

hugo-whisper-theme

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README