zegonix/navigate
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

updated the readme file

Browse Source
This commit is contained in:
quak
2025-02-01 23:05:47 +01:00
parent 97416600f4
commit 50a24b7503
1 changed files with 4 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+4 -25
View File
@@ -30,28 +30,9 @@ Every shell has its own stack, save in the file `/tmp/navigate/<process-id>`.
The behaviour of `navigate` can be configured in the file `$XDG_CONFIG_HOME/navigate/navigate.toml`.
*It has the toml extension, but might not implement the full toml specification.*
At the time of writing, the following options are recognised:
* `general`
* `show_stack_on_push`: bool = false
* `show_stack_on_pop`: bool = false
* `show_books_on_bookmark`: bool = false
* `format`
* `align_separators`: bool = true
* `stack_separator`: string = " - "
* `stack_home_as_tilde`: bool = false
* `bookmarks_separator`: string = " - "
* `book_home_as_tilde`: bool = false
* `styles`
* `warning_style`: string = "yellow, italic"
* `error_style`: string = "red, bold"
* `stack_number_style`: string = "default"
* `stack_separator_style`: string = "cyan"
* `stack_path_style`: string = "default"
* `stack_punct_style`: string = "magenta"
* `bookmarks_name_style`: string = "default"
* `bookmarks_separator_style`: string = "cyan"
* `bookmarks_path_style`: string = "default"
* `bookmarks_punct_style`: string = "magenta"
> `navigate` will check for the file `default.toml` in the configuration directory and create it if not found.
> It contains all settings with default values and a short explanation.
> After an update one can delete the file and call any subcommand of `navigate` to get an updated default configuration.
The lines without type and value are categories and need to be defined as toml table (`[table]`) in the configuration file.
Options are written as `value = key`.
@@ -61,7 +42,5 @@ Style settings accept styles and one color in the following formats:
* **numbered color**: `16`..`255`
* **rgb color**: `#rrggbb`
***NOTE**: The styles and colors are applied as ansi escape sequences and most terminals do not support all options.*
See [navigate.toml](./navigate.toml) for an example configuration file.
> *NOTE*: The styles and colors are applied as ansi escape sequences and I do not know a terminal which implements all sequences.