From 29428c692e62cbad03dea54b14a12137ddf836c5 Mon Sep 17 00:00:00 2001 From: Henk Verlinde Date: Mon, 21 Feb 2022 17:01:51 +0100 Subject: [PATCH] content: update quick start and command pages --- content/en/docs/prologue/commands.md | 14 +++++++++++++ content/en/docs/prologue/quick-start.md | 28 +++++++++++++++++-------- 2 files changed, 33 insertions(+), 9 deletions(-) diff --git a/content/en/docs/prologue/commands.md b/content/en/docs/prologue/commands.md index e647a98..a546026 100644 --- a/content/en/docs/prologue/commands.md +++ b/content/en/docs/prologue/commands.md @@ -25,6 +25,20 @@ npm run create [path] [flags] 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 Check scripts, styles, and markdown for errors: diff --git a/content/en/docs/prologue/quick-start.md b/content/en/docs/prologue/quick-start.md index 9282d3e..e42701e 100644 --- a/content/en/docs/prologue/quick-start.md +++ b/content/en/docs/prologue/quick-start.md @@ -15,9 +15,12 @@ toc: true ## 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 @@ -25,25 +28,32 @@ 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: +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. +#### Child theme -Not quite sure? Use the Doks child theme. - -#### Doks child theme +- Intended for novice to intermediate users +- Intended for minor customizations +- [Easily update npm packages]({{< relref "how-to-update" >}}) — __including__ [Doks](https://www.npmjs.com/package/@hyas/doks) ```bash 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 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 ```bash