docs: add filtering files/directories section

yazi-rs · Jan 9, 2024 · 0098d12 · 0098d12
1 parent eddec26
commit 0098d12
Show file tree

Hide file tree

Showing 3 changed files with 28 additions and 18 deletions.
diff --git a/docs/configuration/keymap.md b/docs/configuration/keymap.md
@@ -163,9 +163,10 @@ If you haven't created and used your own configuration file yet, please see [Con
 
   - `by`: Optional, if not provided, the sort method will be kept unchanged.
     - `"none"`: Don't sort.
-    - `"alphabetical"`: Sort alphabetically, e.g. `1.md` < `10.md` < `2.md`
-    - `"created"`: Sort by creation time.
     - `"modified"`: Sort by last modified time.
+    - `"created"`: Sort by creation time.
+    - `"extension"`: Sort by file extension.
+    - `"alphabetical"`: Sort alphabetically, e.g. `1.md` < `10.md` < `2.md`
     - `"natural"`: Sort naturally, e.g. `1.md` < `2.md` < `10.md`
     - `"size"`: Sort by file size.
   - `--reverse`: Display files in reverse order.

diff --git a/docs/configuration/yazi.md b/docs/configuration/yazi.md
@@ -17,12 +17,13 @@ If you haven't created and used your own configuration file yet, please see [Con
 
 - sort_by: File sorting method
 
-  - `"none"`: Don't sort
+  - `"none"`: Don't sort.
+  - `"modified"`: Sort by last modified time.
+  - `"created"`: Sort by creation time.
+  - `"extension"`: Sort by file extension.
   - `"alphabetical"`: Sort alphabetically, e.g. `1.md` < `10.md` < `2.md`
-  - `"created"`: Sort by creation time
-  - `"modified"`: Sort by last modified time
   - `"natural"`: Sort naturally, e.g. `1.md` < `2.md` < `10.md`
-  - `"size"`: Sort by file size
+  - `"size"`: Sort by file size.
 
 - sort_sensitive: Sort case-sensitively
 

diff --git a/docs/quick-start.md b/docs/quick-start.md
@@ -103,6 +103,12 @@ _Observation: `c ⇒ d` indicates pressing the `c` key followed by pressing the
 | c ⇒ f       | Copy the name of the file                       |
 | c ⇒ n       | Copy the name of the file without the extension |
 
+### Filtering files/directories
+
+| Key binding | Action                              |
+| ----------- | ----------------------------------- |
+| f           | Filter the files/directories in CWD |
+
 ### Finding files/directories
 
 | Key binding | Action                              |
@@ -118,18 +124,20 @@ To sort files/directories use the following commands.
 
 _Observation: `, ⇒ a` indicates pressing the `,` key followed by pressing the `a` key._
 
-| Key binding | Action                          |
-| ----------- | ------------------------------- |
-| , ⇒ a       | Sort alphabetically             |
-| , ⇒ A       | Sort alphabetically (reverse)   |
-| , ⇒ c       | Sort by creation time           |
-| , ⇒ C       | Sort by creation time (reverse) |
-| , ⇒ m       | Sort by modified time           |
-| , ⇒ M       | Sort by modified time (reverse) |
-| , ⇒ n       | Sort naturally                  |
-| , ⇒ N       | Sort naturally (reverse)        |
-| , ⇒ s       | Sort by size                    |
-| , ⇒ S       | Sort by size (reverse)          |
+| Key binding | Action                           |
+| ----------- | -------------------------------- |
+| , ⇒ m       | Sort by modified time            |
+| , ⇒ M       | Sort by modified time (reverse)  |
+| , ⇒ c       | Sort by creation time            |
+| , ⇒ C       | Sort by creation time (reverse)  |
+| , ⇒ e       | Sort by file extension           |
+| , ⇒ E       | Sort by file extension (reverse) |
+| , ⇒ a       | Sort alphabetically              |
+| , ⇒ A       | Sort alphabetically (reverse)    |
+| , ⇒ n       | Sort naturally                   |
+| , ⇒ N       | Sort naturally (reverse)         |
+| , ⇒ s       | Sort by size                     |
+| , ⇒ S       | Sort by size (reverse)           |
 
 ## Changing working directory when exiting Yazi