Skip to content
This repository has been archived by the owner on Sep 28, 2023. It is now read-only.

Commit

Permalink
content: update content for Doks v0.5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
h-enk committed Jul 9, 2022
1 parent 5a8fa90 commit 63d4412
Show file tree
Hide file tree
Showing 14 changed files with 128 additions and 13 deletions.
3 changes: 2 additions & 1 deletion config/_default/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ disableHugoGeneratorInject = true
enableEmoji = true
enableGitInfo = false
enableRobotsTXT = true
languageCode = "en-US"
paginate = 7
rssLimit = 10

Expand Down Expand Up @@ -59,6 +58,8 @@ rel = "sitemap"

[taxonomies]
contributor = "contributors"
category = "categories"
tag = "tags"

[permalinks]
blog = "/blog/:title/"
Expand Down
10 changes: 8 additions & 2 deletions content/en/blog/say-hello-to-doks/index.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
---
title: "Say hello to Doks 👋"
description: "Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default."
lead: "Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default."
excerpt: "Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default."
date: 2020-11-04T09:19:42+01:00
lastmod: 2020-11-04T09:19:42+01:00
draft: false
weight: 50
images: ["say-hello-to-doks.png"]
images: []
categories: ["News"]
tags: ["security", "performance", "SEO"]
contributors: ["Henk Verlinde"]
pinned: false
homepage: false
---

Introducing Doks, a Hugo theme helping you build modern documentation websites that are secure, fast, and SEO-ready — by default.
Binary file not shown.
1 change: 1 addition & 0 deletions content/en/docs/help/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ date: 2020-10-06T08:49:15+00:00
lastmod: 2020-10-06T08:49:15+00:00
draft: false
images: []
weight: 600
---
10 changes: 10 additions & 0 deletions content/en/docs/lorem/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
title: "Lorem"
description: ""
lead: ""
date: 2022-01-18T19:58:14+01:00
lastmod: 2022-01-18T19:58:14+01:00
draft: true
images: []
toc: true
---
15 changes: 15 additions & 0 deletions content/en/docs/lorem/ipsum/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: "Ipsum"
description: ""
lead: ""
date: 2022-01-18T20:00:32+01:00
lastmod: 2022-01-18T20:00:32+01:00
draft: false
images: []
menu:
docs:
parent: "lorem"
identifier: "ipsum"
weight: 999
toc: true
---
15 changes: 15 additions & 0 deletions content/en/docs/lorem/ipsum/amet/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: "Amet"
description: ""
lead: ""
date: 2022-01-18T20:07:56+01:00
lastmod: 2022-01-18T20:07:56+01:00
draft: false
images: []
menu:
docs:
parent: "ipsum"
identifier: "amet"
weight: 999
toc: true
---
14 changes: 14 additions & 0 deletions content/en/docs/lorem/ipsum/amet/consectetur/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: "Consectetur"
description: ""
lead: ""
date: 2022-01-18T20:17:32+01:00
lastmod: 2022-01-18T20:17:32+01:00
draft: false
images: []
menu:
docs:
parent: "amet"
weight: 730
toc: true
---
14 changes: 14 additions & 0 deletions content/en/docs/lorem/ipsum/dolor/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: "Dolor"
description: ""
lead: ""
date: 2022-01-18T20:01:45+01:00
lastmod: 2022-01-18T20:01:45+01:00
draft: false
images: []
menu:
docs:
parent: "ipsum"
weight: 700
toc: true
---
14 changes: 14 additions & 0 deletions content/en/docs/lorem/ipsum/sit/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: "Sit"
description: ""
lead: ""
date: 2022-01-18T20:05:19+01:00
lastmod: 2022-01-18T20:05:19+01:00
draft: false
images: []
menu:
docs:
parent: "ipsum"
weight: 710
toc: true
---
1 change: 1 addition & 0 deletions content/en/docs/prologue/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,5 @@ date: 2020-10-06T08:48:45+00:00
lastmod: 2020-10-06T08:48:45+00:00
draft: false
images: []
weight: 100
---
14 changes: 14 additions & 0 deletions content/en/docs/prologue/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
28 changes: 19 additions & 9 deletions content/en/docs/prologue/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,35 +15,45 @@ 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

Create a new site, change directories, install dependencies, and start development server.

### 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
Expand Down
2 changes: 1 addition & 1 deletion content/en/privacy-policy/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,6 @@ We run [Plausible](https://plausible.io/) analytics on getdoks.org. The followin

## Contact us

[Contact us]({{< ref "contact/index.md" >}}) if you have any questions.
[Contact us]({{< relref "contact/index.md" >}}) if you have any questions.

Effective Date: _27th August 2020_

0 comments on commit 63d4412

Please sign in to comment.