Doks

Doks is a Hugo starter helping you build modern documentation websites.

Features

• Lightweight code base
• 100 scores Google Lighthouse
• A+ scores Mozilla Observatory
• Algolia DocSearch support
• Dark/Light toggle
• Blog ready
• Easily make it your own
• All in Hyas

See a working example at doks.netlify.app

Requirements

Make sure all dependencies have been installed:

• Hugo >= 0.69.0/extended
• Node.js >= 13.11.0
• Yarn >= 1.22.4 (recommended)

Get started

Create a new Doks project:

$ git clone git@github.com:h-enk/doks.git my-doks-site

Install dependencies:

# @ my-doks-site/
$ yarn install

Build development theme with live reloading and injection:

# @ my-doks-site/
$ yarn start

Other commands

• yarn lint:styles - Check Sass for errors
• yarn lint:scripts - Check JavaScript for errors
• yarn clean - Delete temporary directories
• yarn build - Build production theme

Documentation

• Hugo
• Hyas
• Doks