158 lines
3.3 KiB
Markdown
158 lines
3.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
|
|
---
|
|
|
|
## Flow
|
|
|
|
{{< mermaid class="bg-light text-center">}}
|
|
graph TD
|
|
A[Hard] -->|Text| B(Round)
|
|
B --> C{Decision}
|
|
C -->|One| D[Result 1]
|
|
C -->|Two| E[Result 2]
|
|
{{< /mermaid >}}
|
|
|
|
## Sequence
|
|
|
|
{{< mermaid >}}
|
|
sequenceDiagram
|
|
Alice->>John: Hello John, how are you?
|
|
loop Healthcheck
|
|
John->>John: Fight against hypochondria
|
|
end
|
|
Note right of John: Rational thoughts!
|
|
John-->>Alice: Great!
|
|
John->>Bob: How about you?
|
|
Bob-->>John: Jolly good!
|
|
{{< /mermaid >}}
|
|
|
|
## Gantt
|
|
|
|
{{< mermaid >}}
|
|
gantt
|
|
section Section
|
|
Completed :done, des1, 2014-01-06,2014-01-08
|
|
Active :active, des2, 2014-01-07, 3d
|
|
Parallel 1 : des3, after des1, 1d
|
|
Parallel 2 : des4, after des1, 1d
|
|
Parallel 3 : des5, after des3, 1d
|
|
Parallel 4 : des6, after des4, 1d
|
|
{{< /mermaid >}}
|
|
|
|
## Class
|
|
|
|
{{< mermaid >}}
|
|
classDiagram
|
|
classA --|> classB : Inheritance
|
|
classC --* classD : Composition
|
|
classE --o classF : Aggregation
|
|
classG --> classH : Association
|
|
classI -- classJ : Link(Solid)
|
|
classK ..> classL : Dependency
|
|
classM ..|> classN : Realization
|
|
classO .. classP : Link(Dashed)
|
|
{{< /mermaid >}}
|
|
|
|
## State
|
|
|
|
{{< mermaid >}}
|
|
stateDiagram-v2
|
|
[*] --> Still
|
|
Still --> [*]
|
|
Still --> Moving
|
|
Moving --> Still
|
|
Moving --> Crash
|
|
Crash --> [*]
|
|
{{< /mermaid >}}
|
|
|
|
## Pie
|
|
|
|
{{< mermaid >}}
|
|
pie
|
|
title Key elements in Product X
|
|
"Calcium" : 42.96
|
|
"Potassium" : 50.05
|
|
"Magnesium" : 10.01
|
|
"Iron" : 5
|
|
{{< /mermaid >}}
|
|
|
|
## User Journey
|
|
|
|
{{< mermaid >}}
|
|
journey
|
|
title My working day
|
|
section Go to work
|
|
Make tea: 5: Me
|
|
Go upstairs: 3: Me
|
|
Do work: 1: Me, Cat
|
|
section Go home
|
|
Go downstairs: 5: Me
|
|
Sit down: 3: Me
|
|
{{< /mermaid >}}
|
|
|
|
## Requirements
|
|
|
|
Doks uses npm to centralize dependency management, making it [easy to update]({{< relref "how-to-update" >}}) resources, build tooling, plugins, and build scripts:
|
|
|
|
- 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
|
|
|
|
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
|
|
|
|
```bash
|
|
git clone https://github.com/h-enk/doks-child-theme.git my-doks-site
|
|
```
|
|
|
|
#### Doks starter theme
|
|
|
|
```bash
|
|
git clone https://github.com/h-enk/doks.git my-doks-site
|
|
```
|
|
|
|
### Change directories
|
|
|
|
```bash
|
|
cd my-doks-site
|
|
```
|
|
|
|
### Install dependencies
|
|
|
|
```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
|
|
|
|
Doks comes with commands for common tasks. [Commands →]({{< relref "commands" >}})
|