From b8d9014d8388c5ac73cbed421d3f510e58f7d506 Mon Sep 17 00:00:00 2001
From: sxyazi <sxyazi@gmail.com>
Date: Thu, 20 Jul 2023 17:32:03 +0800
Subject: [PATCH] docs: more docs

---
 README.md     |  2 +-
 docs/theme.md |  3 +++
 docs/yazi.md  | 70 +++++++++++++++++++++++++++++++++++++++++++++++++++
 3 files changed, 74 insertions(+), 1 deletion(-)
 create mode 100644 docs/theme.md
 create mode 100644 docs/yazi.md

diff --git a/README.md b/README.md
index 8ed3a676..61dbd277 100644
--- a/README.md
+++ b/README.md
@@ -71,7 +71,7 @@ If you want to use your own config, copy the [config folder](https://github.com/
 - [x] Add example config for general usage, currently please see my [another repo](https://github.com/sxyazi/dotfiles/tree/main/yazi) instead
 - [x] Integration with fzf, zoxide for fast directory navigation
 - [x] Integration with fd, rg for fuzzy file searching
-- [ ] Documentation of commands and options
+- [x] Documentation of commands and options
 - [ ] Support for Überzug++ for image previews with X11/wayland environment
 - [ ] Batch renaming support
 
diff --git a/docs/theme.md b/docs/theme.md
new file mode 100644
index 00000000..881b03f1
--- /dev/null
+++ b/docs/theme.md
@@ -0,0 +1,3 @@
+# Theme
+
+Just some colors, feel free to modify as you like, following the format in [../config/theme.toml](../config/theme.toml).
diff --git a/docs/yazi.md b/docs/yazi.md
new file mode 100644
index 00000000..53af3fdc
--- /dev/null
+++ b/docs/yazi.md
@@ -0,0 +1,70 @@
+# Yazi
+
+## manager
+
+- sort_by: File sorting method
+
+  - `"alphabetical"`: Sort alphabetically
+  - `"created"`: Sort by creation time
+  - `"modified"`: Sort by last modified time
+  - `"size"`: Sort by file size
+
+- sort_reverse: Display files in reverse order
+
+  - `true`: Reverse order
+  - `false`: Normal order
+
+- show_hidden: Show hidden files
+
+  - `true`: Show
+  - `false`: Do not show
+
+## preview
+
+- tab_size: Tab width
+- max_width: Maximum preview width for images and videos
+- max_height: Maximum preview height for images and videos
+
+## opener
+
+Configure available openers, for example:
+
+```toml
+[opener]
+archive = [
+	{ cmd = "unar", args = [ "$1" ] },
+]
+text = [
+	{ cmd = "nvim", args = [ "$*" ], block = true },
+]
+# ...
+```
+
+Available parameters are as follows:
+
+- cmd: The program to open the selected files
+- args: Arguments to be passed
+  - `$n`: The n-th selected item
+  - `$*`: All selected files
+- block: Open in a blocking manner. After setting this, Yazi will hide into a secondary screen and display the program on the main screen until it exits. During this time, it can receive I/O signals, which is useful for interactive programs.
+
+## open
+
+Set rules for opening specific files, for example:
+
+```toml
+[open]
+rules = [
+	{ mime = "text/*", use = "text" },
+	{ mime = "image/*", use = "image" },
+
+	# { mime = "application/json", use = "text" },
+	{ name = "*.json", use = "text" },
+]
+```
+
+Available rule parameters are as follows:
+
+- name: Glob expression for matching the file name
+- mime: Glob expression for matching the MIME type
+- use: Opener name corresponding to the names in the opener section.