Create configuration/config-example.yaml

docs/examples/configuration/config-example.yaml

@@ -0,0 +1,39 @@
+# THIS IS EXPERIMENTAL
+# the config file schema may change at any time
+
+style:
+  tag:
+    color: cyan # text color. possible values: https://bit.ly/3gloNNI
+    width_percentage: 26 # column width relative to the terminal window
+    min_width: 20 # minimum column width as number of characters
+  comment:
+    color: blue
+    width_percentage: 42
+    min_width: 45
+  snippet:
+    color: white
+
+finder:
+  command: fzf # equivalent to the --finder option
+  # overrides: --tac # equivalent to the --fzf-overrides option
+  # overrides_var: --tac # equivalent to the --fzf-overrides-var option
+  # delimiter_var: \s\s+ # equivalent to the --delimiter option that is used with --column option when you extract a column from the selected result for a variable
+
+# cheats:
+#   paths:
+#     - /path/to/some/dir # on unix-like os
+#     - F:\\path\\to\\dir # on Windows
+# path: /path/to/some/dir # (DEPRECATED) equivalent to the --path option
+
+# search:
+#   tags: git,!checkout # equivalent to the --tag-rules option
+
+# client:
+#   tealdeer: true # enables tealdeer support for navi --tldr
+
+shell:
+  # Shell used for shell out. Possible values: bash, zsh, dash, ...
+  # For Windows, use `cmd.exe` instead.
+  command: bash
+
+  # finder_command: bash # similar, but for fzf's internals