Skip to content

Commit

Permalink
docs: update content
Browse files Browse the repository at this point in the history
  • Loading branch information
h-enk committed Nov 5, 2020
1 parent 81d7b1a commit c6ea4f3
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 60 deletions.
11 changes: 3 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
9 changes: 0 additions & 9 deletions content/docs/help/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -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: `/`
Expand Down
62 changes: 29 additions & 33 deletions content/docs/prologue/commands.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
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
Expand All @@ -13,80 +13,76 @@ 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

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
```
11 changes: 3 additions & 8 deletions content/docs/prologue/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
3 changes: 1 addition & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down

0 comments on commit c6ea4f3

Please sign in to comment.