61 lines
1.3 KiB
Markdown
61 lines
1.3 KiB
Markdown
|
---
|
||
|
|
title: "Quick Start"
|
||
|
|
description: "One page summary of how to start a new Doks project."
|
||
|
|
lead: "One page summary of how to start a new Doks project."
|
||
|
|
date: 2020-11-16T13:59:39+01:00
|
||
|
|
lastmod: 2020-11-16T13:59:39+01:00
|
||
|
|
draft: false
|
||
|
|
images: []
|
||
|
|
menu:
|
||
|
|
docs:
|
||
|
|
parent: "prologue"
|
||
|
|
weight: 110
|
||
|
|
toc: true
|
||
|
|
---
|
||
|
|
|
||
|
|
## Requirements
|
||
|
|
|
||
|
|
Doks uses npm to install dependencies and run commands. Installing npm is pretty simple. Download and install [Node.js](https://nodejs.org/) (it includes npm) for your platform.
|
||
|
|
|
||
|
|
## Start a new Doks project
|
||
|
|
|
||
|
|
Create a new site, change directories, install dependencies, and start development server.
|
||
|
|
|
||
|
|
### Create a new site
|
||
|
|
|
||
|
|
{{< btn-copy text="git clone https://github.com/h-enk/doks.git my-doks-site" >}}
|
||
|
|
|
||
|
|
```bash
|
||
|
|
git clone https://github.com/h-enk/doks.git my-doks-site
|
||
|
|
```
|
||
|
|
|
||
|
|
### Change directories
|
||
|
|
|
||
|
|
{{< btn-copy text="cd my-doks-site" >}}
|
||
|
|
|
||
|
|
```bash
|
||
|
|
cd my-doks-site
|
||
|
|
```
|
||
|
|
|
||
|
|
### Install dependencies
|
||
|
|
|
||
|
|
{{< btn-copy text="npm install" >}}
|
||
|
|
|
||
|
|
```bash
|
||
|
|
npm install
|
||
|
|
```
|
||
|
|
|
||
|
|
### Start development server
|
||
|
|
|
||
|
|
{{< btn-copy text="npm run start" >}}
|
||
|
|
|
||
|
|
```bash
|
||
|
|
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" >}})
|