Llewellyn/starship
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-12-01 09:13:54 +00:00
Code Issues Releases Activity

docs(directory): fix $read_only variable names

Browse Source 
Fixes #1706
This commit is contained in:
Matan Kushner 2020-09-30 18:38:57 -04:00
parent 7c15b26ac9
commit ce73f6347f
No known key found for this signature in database
GPG Key ID: B791E33704A84549
2 changed files with 46 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

88
docs/config/README.md
View File

@ -642,15 +642,15 @@ it would have been `nixpkgs/pkgs`.
### Options ### Options
| Variable | Default | Description | | Variable | Default | Description |
| ------------------------ | ----------------------------------------------- | -------------------------------------------------------------------------------- | | ------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------- |
| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. | | `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. | | `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. | | `format` | `"[$path]($style)[$read_only]($read_only_style) "` | The format for the module. |
| `style` | `"bold cyan"` | The style for the module. | | `style` | `"bold cyan"` | The style for the module. |
| `disabled` | `false` | Disables the `directory` module. | | `disabled` | `false` | Disables the `directory` module. |
| `read_only_symbol` | `"🔒"` | The symbol indicating current directory is read only. | | `read_only` | `"🔒"` | The symbol indicating current directory is read only. |
| `read_only_symbol_style` | `"red"` | The style for the read only symbol. | | `read_only_style` | `"red"` | The style for the read only symbol. |
<details> <details>
<summary>This module has a few advanced configuration options that control how the directory is displayed.</summary> <summary>This module has a few advanced configuration options that control how the directory is displayed.</summary>
@ -1121,21 +1121,21 @@ current directory.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ----------------- | ------------------------------------------- | ---------------------------------------------------- | | ------------ | ------------------------------------------- | ----------------------------------- |
| `format` | `"[\[$all_status$ahead_behind\]]($style) "` | The default format for `git_status` | | `format` | `"[\[$all_status$ahead_behind\]]($style) "` | The default format for `git_status` |
| `conflicted` | `"="` | This branch has merge conflicts. | | `conflicted` | `"="` | This branch has merge conflicts. |
| `ahead` | `"⇡"` | The format of `ahead` | | `ahead` | `"⇡"` | The format of `ahead` |
| `behind` | `"⇣"` | The format of `behind` | | `behind` | `"⇣"` | The format of `behind` |
| `diverged` | `"⇕"` | The format of `diverged` | | `diverged` | `"⇕"` | The format of `diverged` |
| `untracked` | `"?"` | The format of `untracked` | | `untracked` | `"?"` | The format of `untracked` |
| `stashed` | `"$"` | The format of `stashed` | | `stashed` | `"$"` | The format of `stashed` |
| `modified` | `"!"` | The format of `modified` | | `modified` | `"!"` | The format of `modified` |
| `staged` | `"+"` | The format of `staged` | | `staged` | `"+"` | The format of `staged` |
| `renamed` | `"»"` | The format of `renamed` | | `renamed` | `"»"` | The format of `renamed` |
| `deleted` | `"✘"` | The format of `deleted` | | `deleted` | `"✘"` | The format of `deleted` |
| `style` | `"bold red"` | The style for the module. | | `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `git_status` module. | | `disabled` | `false` | Disables the `git_status` module. |
### Variables ### Variables
@ -1188,6 +1188,7 @@ deleted = "🗑"
``` ```
Show ahead/behind count of the branch being tracked Show ahead/behind count of the branch being tracked
```toml ```toml
# ~/.config/starship.toml # ~/.config/starship.toml
@ -1502,13 +1503,13 @@ To enable it, set `disabled` to `false` in your configuration file.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ----------- | --------------------------------------------- | -------------------------------------------------------- | | ----------- | ---------------------- | -------------------------------------------------------- |
| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | | `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. |
| `format` | `"via $symbol [${ram}( | ${swap})]($style) "` | The format for the module. | | `format` | `"via $symbol [${ram}( | ${swap})]($style) "` | The format for the module. |
| `symbol` | `"🐏"` | The symbol used before displaying the memory usage. | | `symbol` | `"🐏"` | The symbol used before displaying the memory usage. |
| `style` | `"bold dimmed white"` | The style for the module. | | `style` | `"bold dimmed white"` | The style for the module. |
| `disabled` | `true` | Disables the `memory_usage` module. | | `disabled` | `true` | Disables the `memory_usage` module. |
### Variables ### Variables
@ -2120,26 +2121,25 @@ To enable it, set `disabled` to `false` in your configuration file.
### Options ### Options
| Variable | Default | Description | | Variable | Default | Description |
| ---------- | ----------------------------- | ------------------------------------------------------ | | ---------- | --------------------------- | ------------------------------------------------------ |
| `format` | `[$symbol$status]($style) ` | The format of the module | | `format` | `[$symbol$status]($style) ` | The format of the module |
| `symbol` | `"✖"` | A format string representing the symbol for the status | | `symbol` | `"✖"` | A format string representing the symbol for the status |
| `style` | `"bold red"` | The style for the module. | | `style` | `"bold red"` | The style for the module. |
| `disabled` | `true` | Disables the `status` module. | | `disabled` | `true` | Disables the `status` module. |
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| -------- | -------- | ------------------------------------ | | -------- | ------- | ------------------------------------ |
| status | `127` | The exit code of the last command | | status | `127` | The exit code of the last command |
| symbol | | Mirrors the value of option `symbol` | | symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string \*: This variable can only be used as a part of a style string
### Example ### Example
```toml ```toml
# ~/.config/starship.toml # ~/.config/starship.toml

2
docs/migrating-to-0.45.0/README.md
View File

@ -139,7 +139,7 @@ error_symbol = "[✖](bold red) "
```diff ```diff
[directory] [directory]
-- prefix = "in " -- prefix = "in "
++ format = "[$path]($style)[$lock_symbol]($lock_style)" ++ format = "[$path]($style)[$read_only]($read_only_style)"
``` ```
#### Environment Variable #### Environment Variable