Skip to content

Commit 6a1600f

Browse files
committed
Documentation
1 parent efe44f6 commit 6a1600f

File tree

2 files changed

+20
-5
lines changed

2 files changed

+20
-5
lines changed

Diff for: docs/plugins/blog.md

+8
Original file line numberDiff line numberDiff line change
@@ -599,6 +599,14 @@ plugins:
599599
post_readtime: false
600600
```
601601

602+
!!! warning "Chinese, Japanese and Korean characters"
603+
604+
Reading time computation currently does not take segmentation of Chinese,
605+
Japanese and Korean characters into account. This means that the reading
606+
time for posts in these languages may be inaccurate. We're planning on
607+
adding support in the future. In the meantime, please use the `readtime`
608+
front matter property to set the reading time.
609+
602610
---
603611

604612
#### <!-- md:setting config.post_readtime_words_per_minute -->

Diff for: docs/setup/setting-up-a-blog.md

+12-5
Original file line numberDiff line numberDiff line change
@@ -544,10 +544,10 @@ descending order.
544544

545545
#### Setting the reading time
546546

547-
When [enabled], the [readtime] package is used to compute the expected reading
548-
time of each post, which is rendered as part of the post and post excerpt.
549-
Nowadays, many blogs show reading times, which is why the [built-in blog plugin]
550-
offers this capability as well.
547+
When [enabled], the reading the expected reading time of each post is computed,
548+
which is rendered as part of the post and post excerpt. Nowadays, many blogs
549+
show reading times, which is why the [built-in blog plugin] offers this
550+
capability as well.
551551

552552
Sometimes, however, the computed reading time might not feel accurate, or
553553
result in odd and unpleasant numbers. For this reason, reading time can be
@@ -566,7 +566,14 @@ readtime: 15
566566

567567
This will disable automatic reading time computation.
568568

569-
[readtime]: https://pypi.org/project/readtime/
569+
!!! warning "Chinese, Japanese and Korean characters"
570+
571+
Reading time computation currently does not take segmentation of Chinese,
572+
Japanese and Korean characters into account. This means that the reading
573+
time for posts in these languages may be inaccurate. We're planning on
574+
adding support in the future. In the meantime, please use the `readtime`
575+
front matter property to set the reading time.
576+
570577
[enabled]: ../plugins/blog.md#config.post_readtime
571578

572579
#### Setting defaults

0 commit comments

Comments
 (0)