diff --git a/config/_default/config.toml b/config/_default/config.toml index 84c789c..4ad3924 100644 --- a/config/_default/config.toml +++ b/config/_default/config.toml @@ -5,7 +5,6 @@ disableHugoGeneratorInject = true enableEmoji = true enableGitInfo = false enableRobotsTXT = true -languageCode = "en-US" paginate = 7 rssLimit = 10 @@ -59,6 +58,8 @@ rel = "sitemap" [taxonomies] contributor = "contributors" + category = "categories" + tag = "tags" [permalinks] blog = "/blog/:title/" diff --git a/content/en/blog/say-hello-to-doks/index.md b/content/en/blog/say-hello-to-doks/index.md index e9c3185..d14d357 100644 --- a/content/en/blog/say-hello-to-doks/index.md +++ b/content/en/blog/say-hello-to-doks/index.md @@ -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. diff --git a/content/en/blog/say-hello-to-doks/say-hello-to-doks.png b/content/en/blog/say-hello-to-doks/say-hello-to-doks.png deleted file mode 100644 index 70d8c78..0000000 Binary files a/content/en/blog/say-hello-to-doks/say-hello-to-doks.png and /dev/null differ diff --git a/content/en/docs/help/_index.md b/content/en/docs/help/_index.md index bc503ec..b5763a3 100644 --- a/content/en/docs/help/_index.md +++ b/content/en/docs/help/_index.md @@ -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 --- diff --git a/content/en/docs/lorem/_index.md b/content/en/docs/lorem/_index.md new file mode 100644 index 0000000..86fcd8f --- /dev/null +++ b/content/en/docs/lorem/_index.md @@ -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 +--- diff --git a/content/en/docs/lorem/ipsum/_index.md b/content/en/docs/lorem/ipsum/_index.md new file mode 100644 index 0000000..e575fc5 --- /dev/null +++ b/content/en/docs/lorem/ipsum/_index.md @@ -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 +--- diff --git a/content/en/docs/lorem/ipsum/amet/_index.md b/content/en/docs/lorem/ipsum/amet/_index.md new file mode 100644 index 0000000..dbbeabd --- /dev/null +++ b/content/en/docs/lorem/ipsum/amet/_index.md @@ -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 +--- diff --git a/content/en/docs/lorem/ipsum/amet/consectetur/index.md b/content/en/docs/lorem/ipsum/amet/consectetur/index.md new file mode 100644 index 0000000..23771e3 --- /dev/null +++ b/content/en/docs/lorem/ipsum/amet/consectetur/index.md @@ -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 +--- diff --git a/content/en/docs/lorem/ipsum/dolor/index.md b/content/en/docs/lorem/ipsum/dolor/index.md new file mode 100644 index 0000000..a744e72 --- /dev/null +++ b/content/en/docs/lorem/ipsum/dolor/index.md @@ -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 +--- diff --git a/content/en/docs/lorem/ipsum/sit/index.md b/content/en/docs/lorem/ipsum/sit/index.md new file mode 100644 index 0000000..e4c84e4 --- /dev/null +++ b/content/en/docs/lorem/ipsum/sit/index.md @@ -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 +--- diff --git a/content/en/docs/prologue/_index.md b/content/en/docs/prologue/_index.md index c3c1c40..d6b467c 100644 --- a/content/en/docs/prologue/_index.md +++ b/content/en/docs/prologue/_index.md @@ -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 --- 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 diff --git a/content/en/privacy-policy/index.md b/content/en/privacy-policy/index.md index e95fd9f..6315024 100644 --- a/content/en/privacy-policy/index.md +++ b/content/en/privacy-policy/index.md @@ -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_