Quick Start

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

On this page

• Requirements
• Start a new Doks project
  • Create a new site
  • Change directories
  • Install dependencies
  • Start development server
• Other commands

Requirements

Doks uses npm to centralize dependency management, making it easy to update resources, build tooling, plugins, and build scripts:

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

👉

Check that you minimally have installed the latest long term support (LTS) version of Node.js, by running node -v in your terminal.

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 →