diff --git a/docs/config/README.md b/docs/config/README.md index 99ee1472..b56a01ea 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -841,19 +841,20 @@ it would have been `nixpkgs/pkgs`. ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------------- | -| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. | -| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. | -| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | The format for the module. | -| `style` | `"bold cyan"` | The style for the module. | -| `disabled` | `false` | Disables the `directory` module. | -| `read_only` | `"🔒"` | The symbol indicating current directory is read only. | -| `read_only_style` | `"red"` | The style for the read only symbol. | -| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | -| `repo_root_style` | `None` | The style for the root of the git repo when `truncate_to_repo` option is set to false. | -| `home_symbol` | `"~"` | The symbol indicating home directory. | -| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) | +| Option | Default | Description | +| ------------------- | ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | +| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. | +| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. | +| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | The format for the module. | +| `style` | `"bold cyan"` | The style for the module. | +| `disabled` | `false` | Disables the `directory` module. | +| `read_only` | `"🔒"` | The symbol indicating current directory is read only. | +| `read_only_style` | `"red"` | The style for the read only symbol. | +| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | +| `repo_root_style` | `None` | The style for the root of the git repo. The default value is equivalent to `style`. | +| `repo_root_format` | `"[$before_root_path]($style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "` | The format of a git repo when `repo_root_style` is defined. | +| `home_symbol` | `"~"` | The symbol indicating home directory. | +| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
This module has a few advanced configuration options that control how the directory is displayed. @@ -890,6 +891,21 @@ a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/ *: This variable can only be used as a part of a style string +
+The git repos have additional variables. + +Let us consider the path `/path/to/home/git_repo/src/lib` + +| Variable | Example | Description | +| ---------------- | --------------------- | --------------------------------------- | +| before_root_path | `"/path/to/home/"` | The path before git root directory path | +| repo_root | `"git_repo"` | The git root directory name | +| path | `"/src/lib"` | The remaining path | +| style | `"black bold dimmed"` | Mirrors the value of option `style` | +| repo_root_style | `"underline white"` | Style for git root directory name | + +
+ ### Example ```toml