diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/config/README.md | 90 | ||||
| -rw-r--r-- | docs/migrating-to-0.45.0/README.md | 2 |
2 files changed, 46 insertions, 46 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index 9429be585..adb97c85d 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -642,15 +642,15 @@ it would have been `nixpkgs/pkgs`. ### Options -| Variable | 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)[$lock_symbol]($lock_style) "` | The format for the module. | -| `style` | `"bold cyan"` | The style for the module. | -| `disabled` | `false` | Disables the `directory` module. | -| `read_only_symbol` | `"๐"` | The symbol indicating current directory is read only. | -| `read_only_symbol_style` | `"red"` | The style for the read only symbol. | +| Variable | 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. | <details> <summary>This module has a few advanced configuration options that control how the directory is displayed.</summary> @@ -1121,21 +1121,21 @@ current directory. ### Options -| Option | Default | Description | -| ----------------- | ------------------------------------------- | ---------------------------------------------------- | -| `format` | `"[\[$all_status$ahead_behind\]]($style) "` | The default format for `git_status` | -| `conflicted` | `"="` | This branch has merge conflicts. | -| `ahead` | `"โก"` | The format of `ahead` | -| `behind` | `"โฃ"` | The format of `behind` | -| `diverged` | `"โ"` | The format of `diverged` | -| `untracked` | `"?"` | The format of `untracked` | -| `stashed` | `"$"` | The format of `stashed` | -| `modified` | `"!"` | The format of `modified` | -| `staged` | `"+"` | The format of `staged` | -| `renamed` | `"ยป"` | The format of `renamed` | -| `deleted` | `"โ"` | The format of `deleted` | -| `style` | `"bold red"` | The style for the module. | -| `disabled` | `false` | Disables the `git_status` module. | +| Option | Default | Description | +| ------------ | ------------------------------------------- | ----------------------------------- | +| `format` | `"[\[$all_status$ahead_behind\]]($style) "` | The default format for `git_status` | +| `conflicted` | `"="` | This branch has merge conflicts. | +| `ahead` | `"โก"` | The format of `ahead` | +| `behind` | `"โฃ"` | The format of `behind` | +| `diverged` | `"โ"` | The format of `diverged` | +| `untracked` | `"?"` | The format of `untracked` | +| `stashed` | `"$"` | The format of `stashed` | +| `modified` | `"!"` | The format of `modified` | +| `staged` | `"+"` | The format of `staged` | +| `renamed` | `"ยป"` | The format of `renamed` | +| `deleted` | `"โ"` | The format of `deleted` | +| `style` | `"bold red"` | The style for the module. | +| `disabled` | `false` | Disables the `git_status` module. | ### Variables @@ -1188,6 +1188,7 @@ deleted = "๐" ``` Show ahead/behind count of the branch being tracked + ```toml # ~/.config/starship.toml @@ -1502,13 +1503,13 @@ To enable it, set `disabled` to `false` in your configuration file. ### Options -| Option | Default | Description | -| ----------- | --------------------------------------------- | -------------------------------------------------------- | -| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | -| `format` | `"via $symbol [${ram}( | ${swap})]($style) "` | The format for the module. | -| `symbol` | `"๐"` | The symbol used before displaying the memory usage. | -| `style` | `"bold dimmed white"` | The style for the module. | -| `disabled` | `true` | Disables the `memory_usage` module. | +| Option | Default | Description | +| ----------- | ---------------------- | -------------------------------------------------------- | +| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | +| `format` | `"via $symbol [${ram}( | ${swap})]($style) "` | The format for the module. | +| `symbol` | `"๐"` | The symbol used before displaying the memory usage. | +| `style` | `"bold dimmed white"` | The style for the module. | +| `disabled` | `true` | Disables the `memory_usage` module. | ### Variables @@ -2113,33 +2114,32 @@ The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`. ::: tip - + This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Options -| Variable | Default | Description | -| ---------- | ----------------------------- | ------------------------------------------------------ | -| `format` | `[$symbol$status]($style) ` | The format of the module | -| `symbol` | `"โ"` | A format string representing the symbol for the status | -| `style` | `"bold red"` | The style for the module. | -| `disabled` | `true` | Disables the `status` module. | - +| Variable | Default | Description | +| ---------- | --------------------------- | ------------------------------------------------------ | +| `format` | `[$symbol$status]($style) ` | The format of the module | +| `symbol` | `"โ"` | A format string representing the symbol for the status | +| `style` | `"bold red"` | The style for the module. | +| `disabled` | `true` | Disables the `status` module. | ### Variables -| Variable | Example | Description | -| -------- | -------- | ------------------------------------ | -| status | `127` | The exit code of the last command | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| Variable | Example | Description | +| -------- | ------- | ------------------------------------ | +| status | `127` | The exit code of the last command | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | \*: This variable can only be used as a part of a style string - ### Example + ```toml # ~/.config/starship.toml diff --git a/docs/migrating-to-0.45.0/README.md b/docs/migrating-to-0.45.0/README.md index c736125d6..9e70872d2 100644 --- a/docs/migrating-to-0.45.0/README.md +++ b/docs/migrating-to-0.45.0/README.md @@ -139,7 +139,7 @@ error_symbol = "[โ](bold red) " ```diff [directory] -- prefix = "in " -++ format = "[$path]($style)[$lock_symbol]($lock_style)" +++ format = "[$path]($style)[$read_only]($read_only_style)" ``` #### Environment Variable |