Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/g1eny0ung/hugo-theme-dream.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorYue Yang <g1enyy0ung@gmail.com>2021-04-17 17:09:02 +0300
committerYue Yang <g1enyy0ung@gmail.com>2021-04-17 17:20:40 +0300
commit93201ffbd3826d1a913fbfa3b9fc553982533041 (patch)
tree8591a4d5fc56e967248088e2b5899e9b8d34bd18 /docs
parentbd3f67ab8c343412f90ac10853491d73980c51ad (diff)
Update docs and related
Diffstat (limited to 'docs')
-rw-r--r--docs/params-configurations.md26
1 files changed, 25 insertions, 1 deletions
diff --git a/docs/params-configurations.md b/docs/params-configurations.md
index 48890c8..5711845 100644
--- a/docs/params-configurations.md
+++ b/docs/params-configurations.md
@@ -67,6 +67,10 @@
[params.advanced]
customCSS = ["css/custom.css"]
customJS = []
+
+ [params.experimental]
+ jsDate = true
+ jsDateFormat = "yyyy年MM月dd日"
```
> For more details with dark mode related params, see [Dark Mode](dark-mode.md).
@@ -245,7 +249,7 @@ Reverse the position of the post content and its aside.
## Advanced
-> Note: Generally, the following advanced parameters are not necessary to be set. Their main purpose is to further customize the entire theme.
+> Note: generally, the following advanced parameters are not necessary to be set. Their main purpose is to further customize the entire theme.
### customCSS = ["css/custom.css"]
@@ -258,3 +262,23 @@ For example, create a folder named `css` under `static`, then add `custom.css` i
Add your custom JS files.
Same as `customCSS`, except all custom JS files will be placed after the theme JS files.
+
+## Experimental
+
+> Note:
+>
+> The experimental parameters are often not perfect. They have advantages as well as certain disadvantages.
+
+### jsDate
+
+Use [Luxon](https://moment.github.io/luxon/index.html) to replace the built-in [.Format](https://gohugo.io/functions/format/) function. This allows you to define the time format more flexibly.
+
+You may not want to use this param if you want the final date is generated at compile time. After setting this param, the date will output as an [RFC3339](https://en.wikipedia.org/wiki/ISO_8601) format and all rest format operations will be executed after the page is loaded.
+
+For how to define the format, see below.
+
+### jsDateFormat
+
+Refer to this page (<https://moment.github.io/luxon/docs/manual/formatting.html>) to define your date format.
+
+For example, `yyyy-MM-dd` represents a date format like `2021-04-17`.