Update README.md
This commit is contained in:
19
README.md
19
README.md
@@ -2,11 +2,12 @@
|
||||
|
||||
A [Yazi](https://github.com/sxyazi/yazi) plugin that adds the basic functionality of [vi-like marks](https://neovim.io/doc/user/motion.html#mark-motions).
|
||||
|
||||
> [!NOTE]
|
||||
> Version 0.2.5+ or the latest main branch of Yazi is required.
|
||||
|
||||
https://github.com/dedukun/bookmarks.yazi/assets/25795432/9a9fe345-dd06-442e-99f1-8475ab22fad5
|
||||
|
||||
## Requirements
|
||||
|
||||
- [Yazi](https://github.com/sxyazi/yazi) v0.2.5+
|
||||
|
||||
## Features
|
||||
|
||||
- Create/delete bookmarks
|
||||
@@ -60,6 +61,7 @@ The following are the default configurations:
|
||||
require("bookmarks"):setup({
|
||||
save_last_directory = false,
|
||||
persist = "none",
|
||||
desc_format = "full",
|
||||
notify = {
|
||||
enable = false,
|
||||
timeout = 1,
|
||||
@@ -90,6 +92,17 @@ There are three possible values for this option:
|
||||
| `all` | All the bookmarks are saved in persistent memory |
|
||||
| `vim` | This mode emulates the vim global marks, i.e., only the bookmarks in upper case (A-Z) are saved to persistent memory |
|
||||
|
||||
### `desc_format`
|
||||
|
||||
The format for the bookmark description.
|
||||
|
||||
There are two possible values for this option:
|
||||
|
||||
| Value | Description |
|
||||
| -------- | -------------------------------------------------------------------------------------------------------------------- |
|
||||
| `full` | The default, it shows the full path of the bookmark, i.e., the parent folder + the hovered file |
|
||||
| `parent` | Only shows the parent folder of the bookmark |
|
||||
|
||||
### `notify`
|
||||
|
||||
When enabled, notifications will be shown when the user creates a new bookmark and deletes one or
|
||||
|
||||
Reference in New Issue
Block a user