From 7f3364a468f7dcfd8c9c84e5737fe5699f0e3a93 Mon Sep 17 00:00:00 2001
From: Ogulcan Celik <ogulcancelik@gmail.com>
Date: Mon, 13 Jul 2026 02:24:09 +0300
Subject: docs: add versioned config reference

---
 .../website/src/content/docs/config-reference.mdx  | 21 +++++++++++++++++
 .../website/src/content/docs/configuration.mdx     |  2 ++
 .../src/content/docs/ja/config-reference.mdx       | 27 ++++++++++++++++++++++
 .../website/src/content/docs/ja/configuration.mdx  |  2 ++
 .../src/content/docs/zh-cn/config-reference.mdx    | 26 +++++++++++++++++++++
 .../src/content/docs/zh-cn/configuration.mdx       |  2 ++
 6 files changed, 80 insertions(+)
 create mode 100644 docs/next/website/src/content/docs/config-reference.mdx
 create mode 100644 docs/next/website/src/content/docs/ja/config-reference.mdx
 create mode 100644 docs/next/website/src/content/docs/zh-cn/config-reference.mdx

(limited to 'docs/next/website/src/content')

diff --git a/docs/next/website/src/content/docs/config-reference.mdx b/docs/next/website/src/content/docs/config-reference.mdx
new file mode 100644
index 00000000..499ee390
--- /dev/null
+++ b/docs/next/website/src/content/docs/config-reference.mdx
@@ -0,0 +1,21 @@
+---
+title: Config reference
+description: Every canonical config.toml key, with types, defaults, and allowed values.
+---
+
+import ConfigReference from '../../components/ConfigReference.astro';
+
+Every canonical key Herdr reads from `config.toml`, flat and filterable. For guided setup
+and the reasoning behind these options, see [Configuration](/docs/configuration/).
+
+Print the full commented default config at any time:
+
+```bash
+herdr --default-config
+```
+
+Custom command bindings (`[[keys.command]]`) are user-defined tables and are not
+listed per key here; see
+[Custom command keybindings](/docs/configuration/#custom-command-keybindings).
+
+<ConfigReference />
diff --git a/docs/next/website/src/content/docs/configuration.mdx b/docs/next/website/src/content/docs/configuration.mdx
index 0f9a7096..d6c1cc2e 100644
--- a/docs/next/website/src/content/docs/configuration.mdx
+++ b/docs/next/website/src/content/docs/configuration.mdx
@@ -5,6 +5,8 @@ description: Configure Herdr keybindings, themes, sidebar behavior, notification
 
 Herdr works without a config file. Add one when you want custom keys, themes, sidebar settings, notifications, or advanced behavior.
 
+Looking for a specific key? The [Config reference](/docs/config-reference/) lists every key with its type, default, and allowed values.
+
 ## Config file
 
 Herdr reads config from:
diff --git a/docs/next/website/src/content/docs/ja/config-reference.mdx b/docs/next/website/src/content/docs/ja/config-reference.mdx
new file mode 100644
index 00000000..7bbb60aa
--- /dev/null
+++ b/docs/next/website/src/content/docs/ja/config-reference.mdx
@@ -0,0 +1,27 @@
+---
+title: 設定リファレンス
+description: Herdr の正規の config.toml キーを、型・デフォルト値・許容値つきで一覧します。
+---
+
+import ConfigReference from '../../../components/ConfigReference.astro';
+
+Herdr が `config.toml` から読み取る正規キーを、フラットに一覧して絞り込めます。
+ガイド付きの設定手順や各オプションの背景は[設定](/ja/docs/configuration/)を参照してください。
+
+コメント付きのデフォルト設定全体はいつでも出力できます:
+
+```bash
+herdr --default-config
+```
+
+カスタムコマンドバインディング（`[[keys.command]]`）はユーザー定義のテーブルのため、
+ここではキーごとに掲載していません。
+[カスタムコマンドキーバインド](/ja/docs/configuration/#カスタムコマンドキーバインド)を参照してください。
+
+各キーの説明は現時点では英語です。
+
+<ConfigReference
+  placeholder="キーを絞り込み（例: sidebar, prefix, sound…）"
+  noMatches="一致するキーはありません。"
+  keyCountLabel="キー"
+/>
diff --git a/docs/next/website/src/content/docs/ja/configuration.mdx b/docs/next/website/src/content/docs/ja/configuration.mdx
index a28ad650..b91d5bd6 100644
--- a/docs/next/website/src/content/docs/ja/configuration.mdx
+++ b/docs/next/website/src/content/docs/ja/configuration.mdx
@@ -5,6 +5,8 @@ description: Herdr のキーバインド、テーマ、サイドバーの挙動
 
 Herdr は設定ファイルなしで動作します。カスタムキー、テーマ、サイドバー設定、通知、高度な挙動が欲しくなったら追加してください。
 
+特定のキーを探していますか？[設定リファレンス](/ja/docs/config-reference/)に、すべてのキーの型・デフォルト値・許容値が一覧されています。
+
 ## 設定ファイル
 
 Herdr は次の場所から設定を読み込みます:
diff --git a/docs/next/website/src/content/docs/zh-cn/config-reference.mdx b/docs/next/website/src/content/docs/zh-cn/config-reference.mdx
new file mode 100644
index 00000000..7f70afa2
--- /dev/null
+++ b/docs/next/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/docs/next/website/src/content/docs/zh-cn/configuration.mdx b/docs/next/website/src/content/docs/zh-cn/configuration.mdx
index 44d2ccfc..6eb429fa 100644
--- a/docs/next/website/src/content/docs/zh-cn/configuration.mdx
+++ b/docs/next/website/src/content/docs/zh-cn/configuration.mdx
@@ -5,6 +5,8 @@ description: 配置 Herdr 的按键绑定、主题、侧边栏行为、通知和
 
 Herdr 无需配置文件即可工作。当你想要自定义按键、主题、侧边栏设置、通知或高级行为时再添加。
 
+在找某个具体的键？[配置参考](/zh-cn/docs/config-reference/)列出了所有键的类型、默认值与允许的取值。
+
 ## 配置文件
 
 Herdr 从这里读取配置:
-- 
cgit v1.2.3