portails/content/docs/prologue/quick-start.md

1.4 KiB

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

{{< alert icon="👉" text="Node.js is needed to install npm packages and run commands." >}}

Make sure all dependencies have been installed:

Start a new Doks project

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

Create a new site

{{< btn-copy text="git clone https://github.com/h-enk/doks.git my-doks-site" >}}

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

Change directories

{{< btn-copy text="cd my-doks-site" >}}

cd my-doks-site

Install npm packages

{{< btn-copy text="npm install" >}}

npm install

Start development server

{{< btn-copy text="npm run start" >}}

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 →]({{< ref "commands" >}})