quick-start.md

title	description	lead	date	lastmod	draft	images	menu	weight	toc
Quick Start	One page summary of how to start a new Doks project.	One page summary of how to start a new Doks project.	2020-11-16 13:59:39 +0100	2020-11-16 13:59:39 +0100	false		docs parent prologue	110	true

Requirements

Doks uses npm to centralize dependency management, making it [easy to update]({{< relref "how-to-update" >}}) resources, build tooling, plugins, and build scripts:

• Download and install Node.js (it includes npm) for your platform.

<iframe width="850" height="500" src="https://www.youtube.com/embed/j7BxKN7HYjk" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>

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:

• Use the Doks child theme, if you do not plan to customize a lot, and/or need future Doks updates.
• Use the Doks starter theme, if you plan to customize a lot, and/or do not need future Doks updates.

Not quite sure? Use the Doks child theme.

Doks child theme

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

Doks starter theme

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

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

Doks comes with commands for common tasks. [Commands →]({{< relref "commands" >}})