docs: update content
This commit is contained in:
parent
81d7b1a5df
commit
c6ea4f3ae5
11
README.md
11
README.md
|
@ -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
|
||||
|
||||
|
|
|
@ -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: `/`
|
||||
|
|
|
@ -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
|
||||
|
@ -13,48 +13,14 @@ 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
|
||||
```
|
||||
|
||||
## build
|
||||
|
||||
Build production website:
|
||||
|
||||
```bash
|
||||
yarn build
|
||||
```
|
||||
|
||||
### :functions
|
||||
|
||||
```bash
|
||||
yarn build:functions
|
||||
```
|
||||
|
||||
### :preview
|
||||
|
||||
```bash
|
||||
yarn build:preview
|
||||
```
|
||||
|
||||
## server
|
||||
|
||||
Start local development server:
|
||||
|
||||
```bash
|
||||
yarn server
|
||||
```
|
||||
|
||||
## clean
|
||||
|
||||
Delete temporary directories:
|
||||
|
||||
```bash
|
||||
yarn clean
|
||||
npm run start
|
||||
```
|
||||
|
||||
## lint
|
||||
|
@ -62,31 +28,61 @@ yarn clean
|
|||
Check scripts, styles, and markdown for errors:
|
||||
|
||||
```bash
|
||||
yarn lint
|
||||
npm run lint
|
||||
```
|
||||
|
||||
### :scripts
|
||||
### scripts
|
||||
|
||||
Check scripts for errors:
|
||||
|
||||
```bash
|
||||
yarn lint:scripts [--fix]
|
||||
npm run lint:scripts [--fix]
|
||||
```
|
||||
|
||||
### :styles
|
||||
### styles
|
||||
|
||||
Check styles for errors:
|
||||
|
||||
```bash
|
||||
yarn lint:styles [--fix]
|
||||
npm run lint:styles [--fix]
|
||||
```
|
||||
|
||||
### :markdown
|
||||
### markdown
|
||||
|
||||
Check markdown for errors:
|
||||
|
||||
```bash
|
||||
yarn lint:markdown [--fix]
|
||||
npm run lint:markdown [--fix]
|
||||
```
|
||||
|
||||
## test
|
||||
## clean
|
||||
|
||||
Check scripts, styles, and markdown for errors:
|
||||
Delete temporary directories:
|
||||
|
||||
```bash
|
||||
yarn test
|
||||
npm run clean
|
||||
```
|
||||
|
||||
## build
|
||||
|
||||
Build production website:
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
### functions
|
||||
|
||||
Build Lambda functions:
|
||||
|
||||
```bash
|
||||
npm run build:functions
|
||||
```
|
||||
|
||||
### preview
|
||||
|
||||
Build production website including draft and future content:
|
||||
|
||||
```bash
|
||||
npm run build:preview
|
||||
```
|
||||
|
|
|
@ -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
|
||||
|
||||
|
|
|
@ -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",
|
||||
|
|
Loading…
Reference in New Issue