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

80 lines
1.9 KiB
Markdown
Raw Normal View History

2020-12-03 16:07:04 +01:00
---
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: []
2021-01-15 20:07:37 +01:00
menu:
2020-12-03 16:07:04 +01:00
docs:
parent: "prologue"
weight: 110
toc: true
---
2021-01-19 08:11:59 +01:00
## Requirements
2021-01-18 16:05:33 +01:00
- [Git](https://git-scm.com/) — latest source release
- [Node.js](https://nodejs.org/) — latest LTS version or newer
2021-04-02 20:01:29 +02:00
{{< 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 >}}
2020-12-03 16:07:04 +01:00
## Start a new Doks project
2021-02-01 10:35:23 +01:00
Create a new site, change directories, install dependencies, and start development server.
2020-12-03 16:07:04 +01:00
### Create a new site
Doks is available as a child theme and a starter theme.
2021-04-02 20:01:29 +02:00
#### Child theme
2021-04-02 20:01:29 +02:00
- Intended for novice to intermediate users
- Intended for minor customizations
- [Easily update npm packages]({{< relref "how-to-update" >}}) — __including__ [Doks](https://www.npmjs.com/package/@hyas/doks)
2021-04-02 20:01:29 +02:00
```bash
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" >}})
2021-04-02 20:01:29 +02:00
2020-12-03 16:07:04 +01:00
```bash
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 >}}
2020-12-03 16:07:04 +01:00
### Change directories
```bash
cd my-doks-site
```
2021-02-01 10:35:23 +01:00
### Install dependencies
2020-12-03 16:07:04 +01:00
```bash
npm install
```
### Start development server
```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
2021-04-02 19:45:05 +02:00
Doks comes with commands for common tasks. [Commands →]({{< relref "commands" >}})