diff options
| author | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-07-13 02:24:09 +0300 |
|---|---|---|
| committer | Ogulcan Celik <ogulcancelik@gmail.com> | 2026-07-13 02:24:09 +0300 |
| commit | 7f3364a468f7dcfd8c9c84e5737fe5699f0e3a93 (patch) | |
| tree | 2a96ec79fe1c500972697c3198a1a6dc4441ee92 /website/src/content/docs/zh-cn | |
| parent | 2c444eee351e9269b270e215cfbf4696e7c6179b (diff) | |
docs: add versioned config reference
Diffstat (limited to 'website/src/content/docs/zh-cn')
| -rw-r--r-- | website/src/content/docs/zh-cn/config-reference.mdx | 26 | ||||
| -rw-r--r-- | website/src/content/docs/zh-cn/configuration.mdx | 2 |
2 files changed, 28 insertions, 0 deletions
diff --git a/website/src/content/docs/zh-cn/config-reference.mdx b/website/src/content/docs/zh-cn/config-reference.mdx new file mode 100644 index 00000000..7f70afa2 --- /dev/null +++ b/website/src/content/docs/zh-cn/config-reference.mdx @@ -0,0 +1,26 @@ +--- +title: 配置参考 +description: Herdr 的所有规范 config.toml 键,包含类型、默认值与允许的取值。 +--- + +import ConfigReference from '../../../components/ConfigReference.astro'; + +Herdr 从 `config.toml` 读取的所有规范键都在这里平铺列出,并支持筛选。 +配置的分步指南与各选项的背景说明见[配置](/zh-cn/docs/configuration/)。 + +随时可以打印带注释的完整默认配置: + +```bash +herdr --default-config +``` + +自定义命令绑定(`[[keys.command]]`)是用户自定义的表,因此不在此处逐键列出, +见[自定义命令按键绑定](/zh-cn/docs/configuration/#自定义命令按键绑定)。 + +各键的描述目前为英文。 + +<ConfigReference + placeholder="筛选键(例如 sidebar、prefix、sound…)" + noMatches="没有匹配的键。" + keyCountLabel="个键" +/> diff --git a/website/src/content/docs/zh-cn/configuration.mdx b/website/src/content/docs/zh-cn/configuration.mdx index 3b64df6f..ac9bc73c 100644 --- a/website/src/content/docs/zh-cn/configuration.mdx +++ b/website/src/content/docs/zh-cn/configuration.mdx @@ -5,6 +5,8 @@ description: 配置 Herdr 的按键绑定、主题、侧边栏行为、通知和 Herdr 无需配置文件即可工作。当你想要自定义按键、主题、侧边栏设置、通知或高级行为时再添加。 +在找某个具体的键?[配置参考](/zh-cn/docs/config-reference/)列出了所有键的类型、默认值与允许的取值。 + ## 配置文件 Herdr 从这里读取配置: |
