portails/content/en/docs/prologue/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-16T13:59:39+01:00	2020-11-16T13:59:39+01:00	false		docs parent prologue	110	true

Requirements

• Git — latest source release
• Node.js — latest LTS version or newer

{{< details "Why Node.js?" >}} Doks uses npm (included with Node.js) to centralize dependency management, making it [easy to update]({{< relref "how-to-update" >}}) resources, build tooling, plugins, and build scripts. {{< /details >}}

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

• Intended for novice to intermediate users
• Intended for minor customizations
• [Easily update npm packages]({{< relref "how-to-update" >}}) — including Doks

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

Starter theme

• Intended for intermediate to advanced users
• Intended for major customizations
• [Easily update npm packages]({{< relref "how-to-update" >}})

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

{{< details "Help me choose" >}} Not sure which one is for you? Pick the child theme. {{< /details >}}

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" >}})