Quick Start

One page summary of how to start a new Doks project.

Requirements

  • Git — latest source release
  • Node.js — latest LTS version or newer
Why Node.js? Doks uses npm (included with Node.js) to centralize dependency management, making it easy to update resources, build tooling, plugins, and build scripts.

Start a new Doks project

Create a new site, change directories, install dependencies, and start development server.

Create a new site

Doks is available as a child theme and a starter theme.

Child theme

git clone https://github.com/h-enk/doks-child-theme.git my-doks-site

Starter theme

git clone https://github.com/h-enk/doks.git my-doks-site
Help me choose Not sure which one is for you? Pick the child theme.

Change directories

cd my-doks-site

Install dependencies

npm install

Start development server

npm run start

Doks will start the Hugo development webserver accessible by default at http://localhost:1313. Saved changes will live reload in the browser.

Other commands

Commands →