hugo/content/en/methods/page/ReadingTime.md
Bjørn Erik Pedersen 9b0050e9aa Squashed 'docs/' content from commit 5c085a37b
git-subtree-dir: docs
git-subtree-split: 5c085a37b297bf12f59efeaae591418ec025c10d
2024-01-27 10:48:33 +01:00

1.4 KiB

title description categories keywords action
ReadingTime Returns the estimated reading time, in minutes, for the given page.
related returnType signatures
methods/page/WordCount
methods/page/FuzzyWordCount
int
PAGE.ReadingTime

The estimated reading time is calculated by dividing the number of words in the content by the reading speed.

By default, Hugo assumes a reading speed of 212 words per minute. For CJK languages, it assumes 500 words per minute.

{{ printf "Estimated reading time: %d minutes" .ReadingTime }}

Reading speed varies by language. Create language-specific estimated reading times on your multilingual site using site parameters.

{{< code-toggle file=hugo >}} [languages] [languages.de] contentDir = 'content/de' languageCode = 'de-DE' languageName = 'Deutsch' weight = 2 [languages.de.params] reading_speed = 179 [languages.en] contentDir = 'content/en' languageCode = 'en-US' languageName = 'English' weight = 1 [languages.en.params] reading_speed = 228 {{< /code-toggle >}}

Then in your template:

{{ $readingTime := div (float .WordCount) .Site.Params.reading_speed }}
{{ $readingTime = math.Ceil $readingTime }}

We cast the .WordCount to a float to obtain a float when we divide by the reading speed. Then round up to the nearest integer.