docs: update

g1eny0ung · Sep 3, 2024 · 41f6db5 · 41f6db5
1 parent f9af22b
commit 41f6db5
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 8 deletions.
diff --git a/docs/pages/CHANGELOG.md b/docs/pages/CHANGELOG.md
@@ -9,11 +9,11 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ### Added
 
-- Add `valineConfig` param to customize Valine comments
+- Add `valineConfig` param to customize Valine comments [#309](https://github.com/g1eny0ung/hugo-theme-dream/pull/309)
 
 ### Deprecated
 
-- Deprecate `VALINE_LANGUAGE` param
+- Deprecate `VALINE_LANGUAGE` param [#309](https://github.com/g1eny0ung/hugo-theme-dream/pull/309)
 
 ## [3.7.0] - 2024-08-29
 

diff --git a/docs/pages/params-configurations.mdx b/docs/pages/params-configurations.mdx
@@ -33,7 +33,6 @@ utterancesRepo = "g1eny0ung/g1eny0ung.github.io"
 # valine = true
 # LEANCLOUD_APP_ID = ""
 # LEANCLOUD_APP_KEY = ""
-# VALINE_LANGUAGE = ""
 
 email = "g1enyy0ung@gmail.com"
 
@@ -53,6 +52,8 @@ showTableOfContents = true
 showSummaryCoverInPost = true
 showPrevNextPost = true
 
+# [params.valineConfig]
+
 [params.advanced]
 # customCSS = ["css/custom.css"]
 # customJS = []
@@ -145,19 +146,26 @@ View https://utteranc.es for more details.
 ### valine
 
 Valine is a fast, simple & efficient Leancloud based no back end comment system.
+You can view https://valine.js.org/en/index.html for more details.
 
-To make it work, you still need to set first two parameters:
+To make it work, you still need to set these two parameters:
 
 ```toml
 [params]
 LEANCLOUD_APP_ID = ""
 LEANCLOUD_APP_KEY = ""
-VALINE_LANGUAGE = "" # optional
 ```
 
-Default language param is "zh-CN" , other supported languages are "zh-TW" , "en" , "ja" .
+You can also use `[params.valineConfig]` to customize Valine comments. For example:
+
+```toml
+[params.valineConfig]
+pageSize = 5
+```
+
+This will set the number of comments per page to 5.
 
-View https://valine.js.org/en/quickstart for more details.
+Refer to https://valine.js.org/en/configuration.html for the full list of configurations.
 
 ### siteStartYear
 

diff --git a/hugo.example.toml b/hugo.example.toml
@@ -34,7 +34,6 @@ headerTitle = "Hugo Theme Dream"
 # valine = true
 # LEANCLOUD_APP_ID = ""
 # LEANCLOUD_APP_KEY = ""
-# VALINE_LANGUAGE = ""
 
 # email = ""
 
@@ -56,6 +55,8 @@ siteStartYear = 2016
 
 # [params.navItems]
 
+# [params.valineConfig]
+
 # [params.advanced]
 # customCSS = ["css/custom.css"]
 # customJS = []