Document the docs_root_section parameter

hbstack · Nov 14, 2024 · eeb0dce · eeb0dce
1 parent eece161
commit eeb0dce
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 0 deletions.
diff --git a/content/modules/docs/overview/index.en.md b/content/modules/docs/overview/index.en.md
@@ -44,6 +44,7 @@ The docs module provides the basic layouts and templates for docs site, it's use
 | Name                 |  Type   | Default | Description                                            |
 | -------------------- | :-----: | :-----: | ------------------------------------------------------ |
 | `comments`           | boolean | `true`  | Whether to display the comments.                       |
+| `docs_root_section`  | boolean | `true`  | When `false` on **First Section**, then the second section will be used as the root section of navigation. |
 | `meta`     | boolean/object | `true` | When `false` then disable all meta.         |
 | `meta.authors` | boolean | `true` | When `false` then disable the authors meta.    |
 | `meta.date`    | boolean | `true` | When `false` then disable the date meta.       |

diff --git a/content/modules/docs/overview/index.zh-hans.md b/content/modules/docs/overview/index.zh-hans.md
@@ -43,6 +43,7 @@ images:
 | Name                 |  Type   | Default | Description                                  |
 | -------------------- | :-----: | :-----: | -------------------------------------------- |
 | `comments`           | boolean | `true`  | 是否显示评论。                               |
+| `docs_root_section`  | boolean | `true`  | 当其于**第一个栏目**为 `false` 时，则第二个栏目将作为文档导航的根栏目。 |
 | `meta`     | boolean/object | `true` | 为 `false` 时，禁用所有元信息。 |
 | `meta.authors` | boolean | `true` | 为 `false` 时，禁用作者元信息。|
 | `meta.date`    | boolean | `true` | 为 `false` 时，禁用日期元信息。|

diff --git a/content/modules/docs/overview/index.zh-hant.md b/content/modules/docs/overview/index.zh-hant.md
@@ -43,6 +43,7 @@ images:
 | Name                 |  Type   | Default | Description                                  |
 | -------------------- | :-----: | :-----: | -------------------------------------------- |
 | `comments`           | boolean | `true`  | 是否顯示評論。                               |
+| `docs_root_section`  | boolean | `true`  | 當其於**第一個欄目**為 `false` 時，則第二個欄目將作為文檔導航的根欄目。 |
 | `meta`     | boolean/object | `true` | 为 `false` 时，禁用所有元信息。 |
 | `meta.authors` | boolean | `true` | 为 `false` 时，禁用作者元信息。|
 | `meta.date`    | boolean | `true` | 为 `false` 时，禁用日期元信息。|