mirror of
https://github.com/gohugoio/hugo.git
synced 2024-12-18 18:16:57 -05:00
50 lines
1.4 KiB
Markdown
50 lines
1.4 KiB
Markdown
|
---
|
||
|
|
title: ReadingTime
|
||
|
|
description: Returns the estimated reading time, in minutes, for the given page.
|
||
|
|
categories: []
|
||
|
|
keywords: []
|
||
|
|
action:
|
||
|
|
related:
|
||
|
|
- methods/page/WordCount
|
||
|
|
- methods/page/FuzzyWordCount
|
||
|
|
returnType: int
|
||
|
|
signatures: [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.
|
||
|
|
|
||
|
|
```go-html-template
|
||
|
|
{{ 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:
|
||
|
|
|
||
|
|
```go-html-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.
|