From a5f3dd61ce53879019049d9a2ba8f049abdfee68 Mon Sep 17 00:00:00 2001
From: Patrick Kollitsch <83281+davidsneighbour@users.noreply.github.com>
Date: Thu, 22 Jan 2026 23:15:29 +0000
Subject: [PATCH] docs(fix): various documentation fixes (#906)
---
site/.frontmatter/database/taxonomyDb.json | 1 +
docs/content/reading-time.md | 34 ++++++++++++++++++++++++++++++++++
site/.frontmatter/database/pinnedItemsDb.json | 0
docs/getting-started.md | 2 +-
site/README.md | 12 +-----------
docs/installation/installation.md | 2 +-
docs/configuration/general.md | 2 +-
site/frontmatter.json | 0
.frontmatter/database/taxonomyDb.json | 2 +-
site/config/_default/hugo.toml | 2 +-
10 files changed, 41 insertions(+), 16 deletions(-)
diff --git a/.frontmatter/database/taxonomyDb.json b/.frontmatter/database/taxonomyDb.json
index daaef03..9e26dfe 100644
--- a/.frontmatter/database/taxonomyDb.json
+++ b/.frontmatter/database/taxonomyDb.json
@@ -1 +1 @@
-{"taxonomy":{"tags":[],"categories":[]}}
\ No newline at end of file
+{}
\ No newline at end of file
diff --git a/docs/configuration/general.md b/docs/configuration/general.md
index c6f157e..fb7e32b 100644
--- a/docs/configuration/general.md
+++ b/docs/configuration/general.md
@@ -15,7 +15,7 @@
This theme includes a shortcode for a contact form that you can add to any page (there is an example on the contact page in the exampleSite folder). One option is to use [formspree.io](//formspree.io/) as proxy to send the actual email. Each month, visitors can send you up to fifty emails without incurring extra charges. Visit the Formspree site to get the "action" link and add it to your shortcode like this:
-```markdown
+```go-html-template
{{</* form-contact action="https://formspree.io/your@email.com" */>}}
```
diff --git a/docs/content/reading-time.md b/docs/content/reading-time.md
new file mode 100644
index 0000000..e2048b0
--- /dev/null
+++ b/docs/content/reading-time.md
@@ -0,0 +1,34 @@
+---
+title: Calculate and show reading time
+date: 2026-01-16T08:00:00.000+0700
+---
+
+The reading time displayed in `layouts/_default/single.html` can now be configured via a `reading_speed` parameter, instead of always using Hugo's computed `.ReadingTime`. ([GitHub][1])
+
+* The theme still only shows reading time when `show_reading_time = true` is enabled (page param or section param). ([GitHub][1])
+* The displayed value is now computed like this:
+
+ * Default (no config): use Hugo's `.ReadingTime` as before. ([GitHub][1])
+ * With config: compute reading time as `ceil(WordCount / .Site.Params.reading_speed)` and pass the resulting integer into the existing `readingTime` i18n string. ([GitHub][1])
+* This follows the approach described in GoHugo's `ReadingTime` documentation, including the multilingual use case. ([gohugo.io][2])
+
+## Configuration
+
+You can set `reading_speed` globally or per language. In multilingual sites, the recommended approach is language-specific `params.reading_speed`. ([gohugo.io][2])
+
+```toml
+[languages]
+ [languages.en.params]
+ reading_speed = 228
+ [languages.de.params]
+ reading_speed = 179
+```
+
+## Notes
+
+* GoHugo's default assumption is 212 words per minute (and 500 for CJK languages) when using `.ReadingTime`; setting `reading_speed` lets you align the displayed value with your own targets per language. ([gohugo.io][2])
+* PR #801 proposed this feature for language params; the final implementation landed via commit `39e2145` (referencing #801) and applies the `reading_speed` override through `.Site.Params.reading_speed`. ([GitHub][3])
+
+[1]: https://github.com/theNewDynamic/gohugo-theme-ananke/commit/39e2145985954eac07dd343a456f5696c8f9e9d6 "theme(fix): add configurability to reading time display · theNewDynamic/gohugo-theme-ananke@39e2145 · GitHub"
+[2]: https://gohugo.io/methods/page/readingtime/ "ReadingTime"
+[3]: https://github.com/theNewDynamic/gohugo-theme-ananke/pull/801 "Support reading_speed language param in single.html by D14rn · Pull Request #801 · theNewDynamic/gohugo-theme-ananke · GitHub"
diff --git a/docs/getting-started.md b/docs/getting-started.md
index e4e8f9d..cf26765 100644
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@@ -50,7 +50,7 @@
This theme includes a shortcode for a contact form that you can add to any page (there is an example on the contact page in the exampleSite folder). One option is to use [formspree.io](//formspree.io/) as proxy to send the actual email. Each month, visitors can send you up to fifty emails without incurring extra charges. Visit the Formspree site to get the "action" link and add it to your shortcode like this:
```go-html-template
-{{/*< form-contact action="https://formspree.io/your@email.com" >*/}}
+{{</* form-contact action="https://formspree.io/your@email.com" */>}}
```
### Read more link
diff --git a/docs/installation/installation.md b/docs/installation/installation.md
index ece30f2..e71f379 100644
--- a/docs/installation/installation.md
+++ b/docs/installation/installation.md
@@ -6,7 +6,7 @@
## Installing the Ananke Theme for Hugo
> [!NOTE]
-> This post was published and might have updates at [kollitsch.dev](https://kollitsch.dev/posts/installing-ananke-theme-hugo/) -->
+> This post was published and might have updates at [kollitsch.dev](https://kollitsch.dev/posts/installing-ananke-theme-hugo/)
If you're following the [Hugo Quickstart guide](https://gohugo.io/getting-started/quick-start/), you'll notice that it currently recommends installing the Ananke theme as a **Git submodule**. While this is a valid approach, Hugo also offers a more powerful alternative: **Hugo Modules**, which leverage Go's module system for better dependency management.
diff --git a/.frontmatter/database/pinnedItemsDb.json b/site/.frontmatter/database/pinnedItemsDb.json
similarity index 100%
rename from .frontmatter/database/pinnedItemsDb.json
rename to site/.frontmatter/database/pinnedItemsDb.json
diff --git a/site/.frontmatter/database/taxonomyDb.json b/site/.frontmatter/database/taxonomyDb.json
new file mode 100644
index 0000000..daaef03
--- /dev/null
+++ b/site/.frontmatter/database/taxonomyDb.json
@@ -0,0 +1 @@
+{"taxonomy":{"tags":[],"categories":[]}}
\ No newline at end of file
diff --git a/site/README.md b/site/README.md
index f31aa4f..74d5ae1 100644
--- a/site/README.md
+++ b/site/README.md
@@ -1,11 +1 @@
-# Ananke Wiki Demo Site
-
-This Hugo site renders the wiki content stored in the repository `docs/` directory
-using the Ananke theme via Hugo modules.
-
-Run locally (after installing Hugo):
-
-```sh
-cd site
-hugo server
-```
+This folder contains the site setup for the documentation. The content for the documentation is under the root's `/docs` directory.
diff --git a/site/config/_default/hugo.toml b/site/config/_default/hugo.toml
index 76ff1a0..b9eb504 100644
--- a/site/config/_default/hugo.toml
+++ b/site/config/_default/hugo.toml
@@ -1,7 +1,7 @@
baseURL = "http://localhost/"
languageCode = "en-us"
title = "Ananke Documentation"
-contentDir = "../docs/"
+contentDir = "../docs"
enableRobotsTXT = true
[markup]
diff --git a/frontmatter.json b/site/frontmatter.json
similarity index 100%
rename from frontmatter.json
rename to site/frontmatter.json
--
Gitblit v1.10.0