Install Hugo

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

Check Hugo Version

This theme uses Hugo Pipes 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.

hugo version

Install Theme

Create a new Hugo site

hugo new site mynewsite

This will create a fresh Hugo site in the folder mynewsite.

Install theme

Copy or git clone this theme into the sites themes folder mynewsite/themes

Install with Git

cd mynewsite
cd themes
git clone https://github.com/jugglerx/hugo-whisper-theme.git

Install from .zip file

You can download the .zip file located here https://github.com/JugglerX/hugo-whisper-theme/archive/master.zip.

Extract the downloaded .zip inside the themes folder. Rename the extracted folder from hugo-whisper-theme-master -> hugo-whisper-theme. You should end up with the following folder structure mynewsite/themes/hugo-whisper-theme

Configuration

Syntax highlighting and menus can be configured via config.toml.

Specimen

Markdown Test Page

• Headings
• Paragraphs
• Blockquotes
• Lists
• Horizontal rule
• Table
• Code
• Inline elements

Headings

Heading one

Sint sit cillum pariatur eiusmod nulla pariatur ipsum. Sit laborum anim qui mollit tempor pariatur nisi minim dolor. Aliquip et adipisicing sit sit fugiat commodo id sunt. Nostrud enim ad commodo incididunt cupidatat in ullamco ullamco Lorem cupidatat velit enim et Lorem.

Hugo Whisper

Whisper is a minimal documentation theme built for Hugo. The design & functionality is intentionally minimal.