document updated

BHznJNs · Feb 12, 2024 · 7deb9de · 7deb9de
1 parent df39953
commit 7deb9de
Show file tree

Hide file tree

Showing 2 changed files with 151 additions and 6 deletions.
diff --git a/static/English/Configuration.md b/static/English/Configuration.md
@@ -18,4 +18,140 @@ The title of the front view, will be shown in the tabbar of browser.
 
 - - -
 
+## Description
 
+##description##
+
+The description for the site, is necessary for the RSS function.
+
+- - -
+
+## Language
+
+##language##
+
+Value: 
+- ``"zh"`` —— Simplified Chinese
+- ``"en"`` —— English
+
+The used language in the front UI.
+
+- - -
+
+## Floating Action Button
+
+##enableFab##
+
+Value: true | false
+
+Used to enable / disable the FABs at the right bottom of front view.
+
+##fabOrdering##
+Default:
+```javascript
+[
+    "catalogSwitcher",
+    "downsizeText",
+    "enlargeText",
+    "backToParent",
+    "backToTop",
+]
+```
+
+Defined the ordering of FABs, if you do not need one of them, just remove it.
+
+- - -
+
+## Catalog
+
+##enableCatalog##
+
+Value: true | false
+
+Used to enable / disable the article catalog function in the front view.
+
+- - -
+
+## RSS
+
+##enableRSS##
+
+Value: true | false
+
+Used to enable / disable the RSS publishing function.
+
+##RSSCapacity##
+
+Value: number
+
+Defined the count of blogs contained in the ``rss.xml``.
+
+##rssIgnoreDir##
+
+Value: ``string[]`` (Array of string)
+
+Ignored directories in the ``rss.xml``, should be the subdirectory of ``static/`` (e.g. there is a directory ``ignored`` in the ``static``, to ignore it, just add ``"ignored"`` to this array).
+
+- - -
+
+## Newest
+
+##enableNewest##
+
+Value: true | false
+
+Used to enable / disable the Newest function.
+
+##newestIgnoreDir##
+
+Value: ``string[]`` (Array of string)
+
+Ignored directories in the Newest, usage is the same as ##rssIgnoreDir##.
+
+- - -
+
+## Page Capacity
+
+##pageCapacity##
+
+Value: number
+
+Defined the shown count of blogs in every page.
+
+- - -
+
+## Port of Preview Server
+
+##previewPort##
+
+Value: number
+
+The default port for preview server.
+
+- - -
+
+## Renderer Library Configuration
+
+##katexOptions##
+
+The configuration for katex.js to render math formulas, see here: [https:\/\/katex.org/docs/options](https://katex.org/docs/options)
+
+##echartsOptions##
+
+The configuration for echarts.js to render charts, see here: [https:\/\/echarts.apache.org/zh/option.html](https://echarts.apache.org/zh/option.html)
+
+##flowchartOptions##
+
+The configuration for flow charts rendering, see here: [https:\/\/flowchart.js.org/](https://flowchart.js.org/)
+
+##ganttOptions##
+
+The configuration for gantt charts rendering, see here: [https:\/\/github.com/frappe/gantt](https://github.com/frappe/gantt)
+
+##railroadOptions##
+
+The configuration for railroad charts rendering, see here: [https:\/\/github.com/tabatkins/railroad-diagrams/blob/gh-pages/README-js.md](https://github.com/tabatkins/railroad-diagrams/blob/gh-pages/README-js.md)
+
+##qrcodeOptions##
+
+The configuration for QRCodes, see here: [https:\/\/github.com/papnkukn/qrcode-svg](https://github.com/papnkukn/qrcode-svg)
diff --git a/static/中文/配置文件.md b/static/中文/配置文件.md
@@ -18,6 +18,14 @@
 
 - - -
 
+## 网站描述
+
+##description##
+
+网站的描述，对于 RSS 功能是必要的。
+
+- - -
+
 ## 语言
 
 ##language##
@@ -71,11 +79,17 @@
 
 用来启用/禁用 RSS 发布功能。
 
+##RSSCapacity##
+
+值：数字
+
+定义 ``rss.xml`` 中包含的博文个数。
+
 ##rssIgnoreDir##
 
 值：``string[]``（字符串数组）
 
-在 RSS 文件中屏蔽的目录，应为 ``static`` 目录下的子目录。（例如，``static/`` 下有一文件夹 ``ignored``，要将其屏蔽，只需将 ``"ignored"`` 添加到此字符串数组中即可）。
+在 RSS 文件中屏蔽的目录，应为 ``static`` 目录下的子目录。（例如，``static`` 下有一文件夹 ``ignored``，要将其屏蔽，只需将 ``"ignored"`` 添加到此字符串数组中即可）。
 
 - - -
 
@@ -87,11 +101,6 @@
 
 用来启用/禁用 最新博文 功能。
 
-##RSSCapacity##
-
-值：数字
-
-定义 ``rss.xml`` 中包含的博文个数。
 
 ##newestIgnoreDir##