content: update quick start and command pages

This commit is contained in:
Henk Verlinde 2022-02-21 17:01:51 +01:00
parent f9569b7a59
commit 29428c692e
2 changed files with 33 additions and 9 deletions

View File

@ -25,6 +25,20 @@ npm run create [path] [flags]
See also the Hugo docs: [hugo new](https://gohugo.io/commands/hugo_new/). See also the Hugo docs: [hugo new](https://gohugo.io/commands/hugo_new/).
### Docs based tree
Create a docs based tree — with a single command:
```bash
npm run create -- --kind docs [section]
```
For example, create a docs based tree named guides:
```bash
npm run create -- --kind docs guides
```
## lint ## lint
Check scripts, styles, and markdown for errors: Check scripts, styles, and markdown for errors:

View File

@ -15,9 +15,12 @@ toc: true
## Requirements ## Requirements
Doks uses npm to centralize dependency management, making it [easy to update]({{< relref "how-to-update" >}}) resources, build tooling, plugins, and build scripts: - [Git](https://git-scm.com/) — latest source release
- [Node.js](https://nodejs.org/) — latest LTS version or newer
- Download and install [Node.js](https://nodejs.org/) (it includes npm) for your platform. {{< details "Why Node.js?" >}}
Doks uses npm (included with Node.js) to centralize dependency management, making it [easy to update]({{< relref "how-to-update" >}}) resources, build tooling, plugins, and build scripts.
{{< /details >}}
## Start a new Doks project ## Start a new Doks project
@ -25,25 +28,32 @@ Create a new site, change directories, install dependencies, and start developme
### Create a new site ### Create a new site
Doks is available as a child theme, and a starter theme: 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. #### Child theme
- 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. - Intended for novice to intermediate users
- Intended for minor customizations
#### Doks child theme - [Easily update npm packages]({{< relref "how-to-update" >}}) — __including__ [Doks](https://www.npmjs.com/package/@hyas/doks)
```bash ```bash
git clone https://github.com/h-enk/doks-child-theme.git my-doks-site git clone https://github.com/h-enk/doks-child-theme.git my-doks-site
``` ```
#### Doks starter theme #### Starter theme
- Intended for intermediate to advanced users
- Intended for major customizations
- [Easily update npm packages]({{< relref "how-to-update" >}})
```bash ```bash
git clone https://github.com/h-enk/doks.git my-doks-site git clone https://github.com/h-enk/doks.git my-doks-site
``` ```
{{< details "Help me choose" >}}
Not sure which one is for you? Pick the child theme.
{{< /details >}}
### Change directories ### Change directories
```bash ```bash