diff options
| -rw-r--r-- | docs/config/README.md | 199 | ||||
| -rw-r--r-- | docs/migrating-to-0.45.0/README.md | 6 |
2 files changed, 102 insertions, 103 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index 5fa675dd6..a2be5361d 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -246,13 +246,13 @@ is read from the `AWS_VAULT` env var. ### Options -| Option | Default | Description | -| ---------------- | ------------------------------------------------ | --------------------------------------------------------------- | -| `format` | `"on [$symbol$profile(\\($region\\))]($style) "` | The format for the module. | -| `symbol` | `"โ๏ธ "` | The symbol used before displaying the current AWS profile. | -| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | -| `style` | `"bold yellow"` | The style for the module. | -| `disabled` | `false` | Disables the `AWS` module. | +| Option | Default | Description | +| ---------------- | ---------------------------------------------- | --------------------------------------------------------------- | +| `format` | `'on [$symbol$profile(\($region\))]($style) '` | The format for the module. | +| `symbol` | `"โ๏ธ "` | The symbol used before displaying the current AWS profile. | +| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | +| `style` | `"bold yellow"` | The style for the module. | +| `disabled` | `false` | Disables the `AWS` module. | ### Variables @@ -273,7 +273,7 @@ is read from the `AWS_VAULT` env var. # ~/.config/starship.toml [aws] -format = "on [$symbol$profile(\\($region\\))]($style) " +format = 'on [$symbol$profile(\($region\))]($style) ' style = "bold blue" symbol = "๐
ฐ " [aws.region_aliases] @@ -360,7 +360,7 @@ style = "bold red" The `display` option is an array of the following table. -| Variable | Description | +| Option | Description | | ----------- | ----------------------------------------------- | | `threshold` | The upper bound for the display option. | | `style` | The style used if the display option is in use. | @@ -600,7 +600,7 @@ The module will be shown if any of the following conditions are met: ### Options -| Variable | Default | Description | +| Option | Default | Description | | ---------- | ---------------------------------- | ----------------------------------------------- | | `format` | `"via [$symbol$version]($style) "` | The format for the module. | | `symbol` | `"๐ฏ "` | A format string representing the symbol of Dart | @@ -642,7 +642,7 @@ it would have been `nixpkgs/pkgs`. ### Options -| Variable | Default | Description | +| 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. | @@ -804,12 +804,12 @@ The module will be shown if any of the following conditions are met: ### Options -| Option | Default | Description | -| ---------- | --------------------------------------------------------- | --------------------------------------------------------------- | -| `symbol` | `"๐ง "` | The symbol used before displaying the version of Elixir/Erlang. | -| `style` | `"bold purple"` | The style for the module. | -| `format` | `"via [$symbol$version \\(OTP $otp_version\\)]($style) "` | The format for the module elixir. | -| `disabled` | `false` | Disables the `elixir` module. | +| Option | Default | Description | +| ---------- | ------------------------------------------------------- | --------------------------------------------------------------- | +| `symbol` | `"๐ง "` | The symbol used before displaying the version of Elixir/Erlang. | +| `style` | `"bold purple"` | The style for the module. | +| `format` | `'via [$symbol$version \(OTP $otp_version\)]($style) '` | The format for the module elixir. | +| `disabled` | `false` | Disables the `elixir` module. | ### Variables @@ -951,13 +951,13 @@ This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gc ### Options -| Variable | Default | Description | -| ---------------- | ------------------------------------------------ | --------------------------------------------------------------- | -| `format` | `"on [$symbol$account(\\($region\\))]($style) "` | The format for the module. | -| `symbol` | `"โ๏ธ "` | The symbol used before displaying the current GCP profile. | -| `region_aliases` | | Table of region aliases to display in addition to the GCP name. | -| `style` | `"bold blue"` | The style for the module. | -| `disabled` | `false` | Disables the `gcloud` module. | +| Option | Default | Description | +| ---------------- | ---------------------------------------------- | --------------------------------------------------------------- | +| `format` | `'on [$symbol$account(\($region\))]($style) '` | The format for the module. | +| `symbol` | `"โ๏ธ "` | The symbol used before displaying the current GCP profile. | +| `region_aliases` | | Table of region aliases to display in addition to the GCP name. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `gcloud` module. | ### Variables @@ -980,7 +980,7 @@ This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gc # ~/.config/starship.toml [gcloud] -format = "on [$symbol$account(\\($project\\))]($style) " +format = 'on [$symbol$account(\($project\))]($style) ' ``` #### Display active config name only @@ -1047,13 +1047,13 @@ The `git_commit` module shows the current commit hash of the repo in your curren ### Options -| Option | Default | Description | -| -------------------- | -------------------------- | ----------------------------------------------------- | -| `commit_hash_length` | `7` | The length of the displayed git commit hash. | -| `format` | `"[\\($hash\\)]($style) "` | The format for the module. | -| `style` | `"bold green"` | The style for the module. | -| `only_detached` | `true` | Only show git commit hash when in detached HEAD state | -| `disabled` | `false` | Disables the `git_commit` module. | +| Option | Default | Description | +| -------------------- | ------------------------ | ----------------------------------------------------- | +| `commit_hash_length` | `7` | The length of the displayed git commit hash. | +| `format` | `'[\($hash\)]($style) '` | The format for the module. | +| `style` | `"bold green"` | The style for the module. | +| `only_detached` | `true` | Only show git commit hash when in detached HEAD state | +| `disabled` | `false` | Disables the `git_commit` module. | ### Variables @@ -1082,18 +1082,18 @@ that information will be shown too. ### Options -| Option | Default | Description | -| -------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `rebase` | `"REBASING"` | A format string displayed when a `rebase` is in progress. | -| `merge` | `"MERGING"` | A format string displayed when a `merge` is in progress. | -| `revert` | `"REVERTING"` | A format string displayed when a `revert` is in progress. | -| `cherry_pick` | `"CHERRY-PICKING"` | A format string displayed when a `cherry-pick` is in progress. | -| `bisect` | `"BISECTING"` | A format string displayed when a `bisect` is in progress. | -| `am` | `"AM"` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. | -| `am_or_rebase` | `"AM/REBASE"` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | -| `style` | `"bold yellow"` | The style for the module. | -| `format` | `"\\([$state( $progress_current/$progress_total)]($style)\\) "` | The format for the module. | -| `disabled` | `false` | Disables the `git_state` module. | +| Option | Default | Description | +| -------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `rebase` | `"REBASING"` | A format string displayed when a `rebase` is in progress. | +| `merge` | `"MERGING"` | A format string displayed when a `merge` is in progress. | +| `revert` | `"REVERTING"` | A format string displayed when a `revert` is in progress. | +| `cherry_pick` | `"CHERRY-PICKING"` | A format string displayed when a `cherry-pick` is in progress. | +| `bisect` | `"BISECTING"` | A format string displayed when a `bisect` is in progress. | +| `am` | `"AM"` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. | +| `am_or_rebase` | `"AM/REBASE"` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | +| `style` | `"bold yellow"` | The style for the module. | +| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | The format for the module. | +| `disabled` | `false` | Disables the `git_state` module. | ### Variables @@ -1112,7 +1112,7 @@ that information will be shown too. # ~/.config/starship.toml [git_state] -format = "[\\($state( $progress_current of $progress_total)\\)]($style) " +format = '[\($state( $progress_current of $progress_total)\)]($style) ' cherry_pick = "[๐ PICKING](bold red)" ``` @@ -1123,21 +1123,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 @@ -1439,14 +1439,13 @@ To enable it, set `disabled` to `false` in your configuration file. ### Options -| Option | Default | Description | -| ----------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | -| `symbol` | `"โธ "` | A format string representing the symbol displayed before the Cluster. | -| `format` | `"[$symbol$context( \\($namespace\\))]($style) in "` | The format for the module. | -| `style` | `"cyan bold"` | The style for the module. | -| `namespace_spaceholder` | `none` | The value to display if no namespace was found. | -| `context_aliases` | | Table of context aliases to display. | -| `disabled` | `true` | Disables the `kubernetes` module. | +| Option | Default | Description | +| ----------------------- | -------------------------------------------------- | --------------------------------------------------------------------- | +| `symbol` | `"โธ "` | A format string representing the symbol displayed before the Cluster. | +| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. | +| `style` | `"cyan bold"` | The style for the module. | +| `context_aliases` | | Table of context aliases to display. | +| `disabled` | `true` | Disables the `kubernetes` module. | ### Variables @@ -1465,7 +1464,7 @@ To enable it, set `disabled` to `false` in your configuration file. # ~/.config/starship.toml [kubernetes] -format = "on [โต $context \\($namespace\\)](dimmed green) " +format = 'on [โต $context \($namespace\)](dimmed green) ' disabled = false [kubernetes.context_aliases] "dev.local.cluster.k8s" = "dev" @@ -1624,14 +1623,14 @@ The module will be shown when inside a nix-shell environment. ### Options -| Option | Default | Description | -| ------------ | ---------------------------------------------- | ----------------------------------------------------- | -| `format` | `"via [$symbol$state( \\($name\\))]($style) "` | The format for the module. | -| `symbol` | `"โ๏ธ "` | A format string representing the symbol of nix-shell. | -| `style` | `"bold blue"` | The style for the module. | -| `impure_msg` | `"impure"` | A format string shown when the shell is impure. | -| `pure_msg` | `"pure"` | A format string shown when the shell is pure. | -| `disabled` | `false` | Disables the `nix_shell` module. | +| Option | Default | Description | +| ------------ | -------------------------------------------- | ----------------------------------------------------- | +| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | +| `symbol` | `"โ๏ธ "` | A format string representing the symbol of nix-shell. | +| `style` | `"bold blue"` | The style for the module. | +| `impure_msg` | `"impure"` | A format string shown when the shell is impure. | +| `pure_msg` | `"pure"` | A format string shown when the shell is pure. | +| `disabled` | `false` | Disables the `nix_shell` module. | ### Variables @@ -1653,7 +1652,7 @@ The module will be shown when inside a nix-shell environment. disabled = true impure_msg = "[impure shell](bold red)" pure_msg = "[pure shell](bold green)" -format = "via [โ๏ธ $state( \\($name\\))](bold blue) " +format = 'via [โ๏ธ $state( \($name\))](bold blue) ' ``` ## NodeJS @@ -1800,7 +1799,7 @@ The module will be shown if any of the following conditions are met: ### Options -| Variable | Default | Description | +| Option | Default | Description | | ---------- | ---------------------------------- | ----------------------------------------------------- | | `format` | `"via [$symbol$version]($style) "` | The format string for the module. | | `symbol` | `"๐ช "` | The symbol used before displaying the version of Perl | @@ -1883,16 +1882,16 @@ The module will be shown if any of the following conditions are met: ### Options -| Option | Default | Description | -| -------------------- | ------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `format` | `"via [${symbol}${pyenv_prefix}${version}( \\($virtualenv\\))]($style) "` | The format for the module. | -| `symbol` | `"๐ "` | A format string representing the symbol of Python | -| `style` | `"yellow bold"` | The style for the module. | -| `pyenv_version_name` | `false` | Use pyenv to get Python version | -| `pyenv_prefix` | `pyenv ` | Prefix before pyenv version display, only used if pyenv is used | -| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. | -| `python_binary` | `python` | Configures the python binary that Starship executes when getting the version. | -| `disabled` | `false` | Disables the `python` module. | +| Option | Default | Description | +| -------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------------- | +| `format` | `'via [${symbol}${pyenv_prefix}${version}( \($virtualenv\))]($style) '` | The format for the module. | +| `symbol` | `"๐ "` | A format string representing the symbol of Python | +| `style` | `"yellow bold"` | The style for the module. | +| `pyenv_version_name` | `false` | Use pyenv to get Python version | +| `pyenv_prefix` | `pyenv ` | Prefix before pyenv version display, only used if pyenv is used | +| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. | +| `python_binary` | `python` | Configures the python binary that Starship executes when getting the version. | +| `disabled` | `false` | Disables the `python` module. | ### Variables @@ -2007,7 +2006,7 @@ set to a number and meets or exceeds the specified threshold. ### Options -| Variable | Default | Description | +| Option | Default | Description | | ----------- | ---------------------------- | --------------------------------------- | | `threshold` | `2` | Display threshold. | | `format` | `"[$symbol$shlvl]($style) "` | The format for the module. | @@ -2043,12 +2042,12 @@ and `$SINGULARITY_NAME` is set. ### Options -| Option | Default | Description | -| ---------- | -------------------------------- | ------------------------------------------------ | -| `format` | `"[$symbol\\[$env\\]]($style) "` | The format for the module. | -| `symbol` | `""` | A format string displayed before the image name. | -| `style` | `"bold dimmed blue"` | The style for the module. | -| `disabled` | `false` | Disables the `singularity` module. | +| Option | Default | Description | +| ---------- | ------------------------------ | ------------------------------------------------ | +| `format` | `'[$symbol\[$env\]]($style) '` | The format for the module. | +| `symbol` | `""` | A format string displayed before the image name. | +| `style` | `"bold dimmed blue"` | The style for the module. | +| `disabled` | `false` | Disables the `singularity` module. | ### Variables @@ -2066,7 +2065,7 @@ and `$SINGULARITY_NAME` is set. # ~/.config/starship.toml [singularity] -format = "[๐ฆ \\[$env\\]]($style) " +format = '[๐ฆ \[$env\]]($style) ' ``` ## Swift @@ -2118,7 +2117,7 @@ To enable it, set `disabled` to `false` in your configuration file. ### Options -| Variable | Default | Description | +| Option | Default | Description | | ---------- | --------------------------- | ------------------------------------------------------ | | `format` | `[$symbol$status]($style) ` | The format of the module | | `symbol` | `"โ"` | A format string representing the symbol for the status | @@ -2144,7 +2143,7 @@ To enable it, set `disabled` to `false` in your configuration file. [status] style = "bg:blue" symbol = "๐ฃ " -format = "[\\[$symbol$status\\]]($style) " +format = '[\[$symbol$status\]]($style) ' disabled = false ``` @@ -2242,7 +2241,7 @@ Manually setting `time_format` will override the `use_12hr` setting. [time] disabled = false -format = "๐[\\[ $time \\]]($style) " +format = '๐[\[ $time \]]($style) ' time_format = "%T" utc_time_offset = "-5" time_range = "10:00:00-14:00:00" diff --git a/docs/migrating-to-0.45.0/README.md b/docs/migrating-to-0.45.0/README.md index 1e484a609..8af694483 100644 --- a/docs/migrating-to-0.45.0/README.md +++ b/docs/migrating-to-0.45.0/README.md @@ -168,7 +168,7 @@ error_symbol = "[โ](bold red)" [git_commit] -- prefix = "(" -- suffix = ")" -++ format = "[\\($hash\\)]($style) " +++ format = '[\($hash\)]($style) ' ``` #### Git Status @@ -186,7 +186,7 @@ error_symbol = "[โ](bold red)" -- prefix = "[" -- suffix = "]" -- show_sync_count = false -++ format = "[\\[$all_status$ahead_behind\\]]($style)" +++ format = '([\[$all_status$ahead_behind\]]($style) )' ``` Previously, the `show_sync_count` property was used to configure the prompt to @@ -234,7 +234,7 @@ behind = "โฃ${count}" [singularity] -- prefix = "" -- suffix = "" -++ format = "[$symbol\\[$env\\]]($style) " +++ format = '[$symbol\[$env\]]($style) ' ``` #### Time |