content: update content for Doks v0.5.0
This commit is contained in:
parent
5a8fa9081c
commit
63d4412ba6
|
@ -5,7 +5,6 @@ disableHugoGeneratorInject = true
|
||||||
enableEmoji = true
|
enableEmoji = true
|
||||||
enableGitInfo = false
|
enableGitInfo = false
|
||||||
enableRobotsTXT = true
|
enableRobotsTXT = true
|
||||||
languageCode = "en-US"
|
|
||||||
paginate = 7
|
paginate = 7
|
||||||
rssLimit = 10
|
rssLimit = 10
|
||||||
|
|
||||||
|
@ -59,6 +58,8 @@ rel = "sitemap"
|
||||||
|
|
||||||
[taxonomies]
|
[taxonomies]
|
||||||
contributor = "contributors"
|
contributor = "contributors"
|
||||||
|
category = "categories"
|
||||||
|
tag = "tags"
|
||||||
|
|
||||||
[permalinks]
|
[permalinks]
|
||||||
blog = "/blog/:title/"
|
blog = "/blog/:title/"
|
||||||
|
|
|
@ -1,11 +1,17 @@
|
||||||
---
|
---
|
||||||
title: "Say hello to Doks 👋"
|
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."
|
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
|
date: 2020-11-04T09:19:42+01:00
|
||||||
lastmod: 2020-11-04T09:19:42+01:00
|
lastmod: 2020-11-04T09:19:42+01:00
|
||||||
draft: false
|
draft: false
|
||||||
weight: 50
|
weight: 50
|
||||||
images: ["say-hello-to-doks.png"]
|
images: []
|
||||||
|
categories: ["News"]
|
||||||
|
tags: ["security", "performance", "SEO"]
|
||||||
contributors: ["Henk Verlinde"]
|
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.
Before Width: | Height: | Size: 8.0 KiB |
|
@ -6,4 +6,5 @@ date: 2020-10-06T08:49:15+00:00
|
||||||
lastmod: 2020-10-06T08:49:15+00:00
|
lastmod: 2020-10-06T08:49:15+00:00
|
||||||
draft: false
|
draft: false
|
||||||
images: []
|
images: []
|
||||||
|
weight: 600
|
||||||
---
|
---
|
||||||
|
|
|
@ -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
|
||||||
|
---
|
|
@ -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
|
||||||
|
---
|
|
@ -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
|
||||||
|
---
|
|
@ -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
|
||||||
|
---
|
|
@ -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
|
||||||
|
---
|
|
@ -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
|
||||||
|
---
|
|
@ -6,4 +6,5 @@ date: 2020-10-06T08:48:45+00:00
|
||||||
lastmod: 2020-10-06T08:48:45+00:00
|
lastmod: 2020-10-06T08:48:45+00:00
|
||||||
draft: false
|
draft: false
|
||||||
images: []
|
images: []
|
||||||
|
weight: 100
|
||||||
---
|
---
|
||||||
|
|
|
@ -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:
|
||||||
|
|
|
@ -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
|
||||||
|
|
|
@ -31,6 +31,6 @@ We run [Plausible](https://plausible.io/) analytics on getdoks.org. The followin
|
||||||
|
|
||||||
## Contact us
|
## 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_
|
Effective Date: _27th August 2020_
|
||||||
|
|
Loading…
Reference in New Issue