content: update for doks v0.2.3

This commit is contained in:
Henk Verlinde
2021-04-02 20:01:29 +02:00
parent 6720e6ea3e
commit b505b2412b
10 changed files with 55 additions and 154 deletions

View File

@ -6,7 +6,7 @@ date: 2020-10-13T15:21:01+02:00
lastmod: 2020-10-13T15:21:01+02:00
draft: false
images: []
menu:
menu:
docs:
parent: "prologue"
weight: 130
@ -15,16 +15,18 @@ toc: true
{{< alert icon="💡" text="You can change the commands in the scripts section of `./package.json`." >}}
## start
## create
Start local development server:
Create new content for your site:
{{< btn-copy text="npm run start" >}}
{{< btn-copy text="npm run create" >}}
```bash
npm run start
npm run create [path] [flags]
```
See also the Hugo docs: [hugo new](https://gohugo.io/commands/hugo_new/).
## lint
Check scripts, styles, and markdown for errors:
@ -75,6 +77,16 @@ Delete temporary directories:
npm run clean
```
## start
Start local development server:
{{< btn-copy text="npm run start" >}}
```bash
npm run start
```
## build
Build production website:

View File

@ -43,11 +43,11 @@ Learn how to customize Doks to fully make it your own. [Reference Guides →](ht
### Extensions
Get instructions on how to add even more to Doks. [Extensions →](https://getdoks.org/docs/extensions/add-google-fonts/)
Get instructions on how to add even more to Doks. [Extensions →](https://getdoks.org/docs/extensions/breadcrumb-navigation/)
### Showcase
See what others have build with Doks. [Showcase →](https://getdoks.org/showcase/parietal-numerics-documentation/)
See what others have build with Doks. [Showcase →](https://getdoks.org/showcase/electric-blocks/)
## Contributing

View File

@ -15,7 +15,9 @@ toc: true
## Requirements
Doks uses npm to install dependencies and run commands. Installing npm is pretty simple. Download and install [Node.js](https://nodejs.org/) (it includes npm) for your platform.
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
@ -23,6 +25,23 @@ Create a new site, change directories, install dependencies, and start developme
### 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
{{< btn-copy text="git clone https://github.com/h-enk/doks-child-theme.git my-doks-site" >}}
```bash
git clone https://github.com/h-enk/doks-child-theme.git my-doks-site
```
#### Doks starter theme
{{< btn-copy text="git clone https://github.com/h-enk/doks.git my-doks-site" >}}
```bash