aboutsummaryrefslogtreecommitdiff
path: root/website/src/content/docs/config-reference.mdx
diff options
context:
space:
mode:
authorOgulcan Celik <ogulcancelik@gmail.com>2026-07-13 02:24:09 +0300
committerOgulcan Celik <ogulcancelik@gmail.com>2026-07-13 02:24:09 +0300
commit7f3364a468f7dcfd8c9c84e5737fe5699f0e3a93 (patch)
tree2a96ec79fe1c500972697c3198a1a6dc4441ee92 /website/src/content/docs/config-reference.mdx
parent2c444eee351e9269b270e215cfbf4696e7c6179b (diff)
docs: add versioned config reference
Diffstat (limited to 'website/src/content/docs/config-reference.mdx')
-rw-r--r--website/src/content/docs/config-reference.mdx21
1 files changed, 21 insertions, 0 deletions
diff --git a/website/src/content/docs/config-reference.mdx b/website/src/content/docs/config-reference.mdx
new file mode 100644
index 00000000..499ee390
--- /dev/null
+++ b/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 />