Commit c6ea4f3a authored by Henk Verlinde's avatar Henk Verlinde
Browse files

docs: update content

parent 81d7b1a5

README.md

+3 −8
Original line number Diff line number Diff line
@@ -40,23 +40,18 @@ git clone https://github.com/h-enk/doks.git my-doks-site 
Install npm packages:



```bash

# @ my-doks-site/

$ npm install

npm install

```



Start local development server:



```bash

# @ my-doks-site/

$ npm run start

npm run start

```



### Other commands



- `npm run lint:styles` - Check Sass for errors

- `npm run lint:scripts` - Check JavaScript for errors

- `npm run clean` - Delete temporary directories

- `npm run build` - Build production website

Doks comes with [commands for most used tasks](https://getdoks.org/docs/prologue/commands/).



## Quick start

content/docs/help/faq.md

+0 −9
Original line number Diff line number Diff line
@@ -13,15 +13,6 @@ weight: 410 
toc: true

---



## What's with the name?



Hyas used [Atlas](https://github.com/indigotree/atlas) 🙏 as a starting point. In Greek mythology,

[Hyas](https://www.greekmythology.com/Other_Gods/Minor_Gods/Hyas/hyas.html) was the son of the Titan Atlas and the Oceanid Aethra.



## Can I get support?



Visit [Hugo Discourse](https://discourse.gohugo.io/) and use the search. If that does not help, start a new topic and ask your question.



## Keyboard shortcuts for search?



- focus: `/`

content/docs/prologue/commands.md

+29 −33
Original line number Diff line number Diff line 
---

title: "Commands"

description: "Repository commands."

lead: "Repository commands."

description: "Doks comes with commands for most used tasks."

lead: "Doks comes with commands for most used tasks."

date: 2020-10-13T15:21:01+02:00

lastmod: 2020-10-13T15:21:01+02:00

draft: false
@@ -13,40 +13,46 @@ weight: 030 
toc: true

---



{{< alert icon="💡" text="You can change the commands in the scripts section of `./package.json`." >}}



## start



Start local development server:



```bash

yarn start

npm run start

```



## build

## lint



Build production website:

Check scripts, styles, and markdown for errors:



```bash

yarn build

npm run lint

```



### :functions

### scripts



Check scripts for errors:



```bash

yarn build:functions

npm run lint:scripts [--fix]

```



### :preview

### styles



Check styles for errors:



```bash

yarn build:preview

npm run lint:styles [--fix]

```



## server

### markdown



Start local development server:

Check markdown for errors:



```bash

yarn server

npm run lint:markdown [--fix]

```



## clean
@@ -54,39 +60,29 @@ yarn server 
Delete temporary directories:



```bash

yarn clean

npm run clean

```



## lint



Check scripts, styles, and markdown for errors:



```bash

yarn lint

```

## build



### :scripts

Build production website:



```bash

yarn lint:scripts [--fix]

npm run build

```



### :styles

### functions



```bash

yarn lint:styles [--fix]

```



### :markdown

Build Lambda functions:



```bash

yarn lint:markdown [--fix]

npm run build:functions

```



## test

### preview



Check scripts, styles, and markdown for errors:

Build production website including draft and future content:



```bash

yarn test

npm run build:preview

```

content/docs/prologue/introduction.md

+3 −8
Original line number Diff line number Diff line
@@ -47,23 +47,18 @@ git clone https://github.com/h-enk/doks.git my-doks-site 
Install npm packages:



```bash

# @ my-doks-site/

$ npm install

npm install

```



Start local development server:



```bash

# @ my-doks-site/

$ npm run start

npm run start

```



### Other commands



- `npm run lint:styles` - Check Sass for errors

- `npm run lint:scripts` - Check JavaScript for errors

- `npm run clean` - Delete temporary directories

- `npm run build` - Build production website

Doks comes with [commands for most used tasks]({{< ref "commands" >}}).



## Quick start

package.json

+1 −2
Original line number Diff line number Diff line
@@ -6,11 +6,10 @@ 
    "defaults"

  ],

  "scripts": {

    "start": "hugo server --disableFastRender",

    "start": "hugo server",

    "build": "hugo --gc --minify && npm run build:functions",

    "build:functions": "netlify-lambda build assets/lambda",

    "build:preview": "npm run build -D -F",

    "server": "hugo server",

    "clean": "rimraf public resources functions",

    "lint": "npm run -s lint:scripts && npm run -s lint:styles && npm run -s lint:markdown",

    "lint:scripts": "eslint assets/js assets/lambda config",