Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
razonyang committed Jul 15, 2021
1 parent 601577c commit 2e4a7cc
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 0 deletions.
3 changes: 3 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,7 @@ As the example site shown, the configuration are separated into multiple files,
| `brand` | String | - | Brand text.
| `menusPosition` | String | `right` | Menus position: `right`, `left`, `center`.
| `description` | String | - | Site description.
| `keywords` | String | - | Site keywords.
| `color` | String | - | Color mode, `light`, `dark` or dynamic. Default to dynamic.
| `palette` | String | - | Default palette. This will take effect after clearing the Cookie.
| `palettes` | Array | **ALL** | Available palettes. You can disable it by setting it to empty `[]`.
Expand Down Expand Up @@ -217,6 +218,8 @@ As the example site shown, the configuration are separated into multiple files,
| Name | Type | Default | Description
|---|:-:|:-:|---
| **Page**
| `description` | String | - | Page description.
| `keywords` | Array | - | Page keywords.
| `comment` | Boolean | `true` | Whether to enable comments. It won't work if `comment` has been disabled globally.
| `toc` | Boolean | `true` | Whether to enable TOC. It won't work if `toc` has been disabled globally.
| `math` | Boolean | `false` | Whether to enable math.
Expand Down
3 changes: 3 additions & 0 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,7 @@ $ hugo new content/zh-CN/newpost.md
| `brand` | String | - | Brand
| `menusPosition` | String | `right` | 菜单位置:`right`, `left`, `center`.
| `description` | String | - | 站点描述
| `keywords` | String | - | 站点关键词
| `color` | String | - | 颜色风格, `light``dark` 或者 dynamic(默认)。
| `palette` | String | - | 默认配色,清理 Cookie 后生效。
| `palettes` | Array | **ALL** | 可选配色,如需禁用此选项,可将其设为空值 `[]`
Expand Down Expand Up @@ -217,6 +218,8 @@ $ hugo new content/zh-CN/newpost.md
| 名称 | 类型 | 默认值 | 说明
|---|:-:|:-:|---
| **Page**
| `description` | String | - | 页面描述
| `keywords` | Array | - | 页面关键词
| `comment` | Boolean | `true` | 是否开启评论,如果评论已被全局关闭,该参数无效
| `toc` | Boolean | `true` | 是否开启目录,如果目录已被全局关闭,该参数无效
| `math` | Boolean | `false` | 是否开启 `math`
Expand Down
3 changes: 3 additions & 0 deletions README.zh-TW.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,7 @@ $ hugo new content/zh-CN/newpost.md
| `brand` | String | - | Brand
| `menusPosition` | String | `right` | 選單位置:`right`, `left`, `center`.
| `description` | String | - | 站點描述
| `keywords` | String | - | 站點關鍵詞
| `color` | String | - | 顏色風格, `light``dark` 或者 dynamic(默認)。
| `palette` | String | - | 預設配色,清理 Cookie 後生效。
| `palettes` | Array | **ALL** | 可選配色,如需禁用此選項,可將其設為空值 `[]`
Expand Down Expand Up @@ -217,6 +218,8 @@ $ hugo new content/zh-CN/newpost.md
| 名稱 | 型別 | 預設值 | 說明
|---|:-:|:-:|---
| **Page**
| `description` | String | - | 頁面描述
| `keywords` | Array | - | 頁面關鍵詞
| `comment` | Boolean | `true` | 是否開啟評論,如果評論已被全域性關閉,該引數無效
| `toc` | Boolean | `true` | 是否開啟目錄,如果目錄已被全域性關閉,該引數無效
| `math` | Boolean | `false` | 是否開啟 `math`
Expand Down

0 comments on commit 2e4a7cc

Please sign in to comment.