summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMatan Kushner <hello@matchai.dev>2021-05-01 14:20:08 -0400
committerGitHub <noreply@github.com>2021-05-01 14:20:08 -0400
commitd6bfe0a3f1176f20cd5028e00e8098908c78692f (patch)
treee730b4ae91de348284eec758f76cfd6d9b3fd8a6
parent7459571a94268af298c53704476ceecd814efa6b (diff)
docs(i18n): new Crowdin updates (#2634)
-rw-r--r--docs/ar-SA/config/README.md594
-rw-r--r--docs/ckb-IR/config/README.md594
-rw-r--r--docs/de-DE/advanced-config/README.md2
-rw-r--r--docs/de-DE/config/README.md910
-rw-r--r--docs/es-ES/advanced-config/README.md2
-rw-r--r--docs/es-ES/config/README.md1498
-rw-r--r--docs/fr-FR/config/README.md694
-rw-r--r--docs/it-IT/README.md2
-rw-r--r--docs/it-IT/advanced-config/README.md2
-rw-r--r--docs/it-IT/config/README.md594
-rw-r--r--docs/ja-JP/README.md2
-rw-r--r--docs/ja-JP/advanced-config/README.md2
-rw-r--r--docs/ja-JP/config/README.md1113
-rw-r--r--docs/ko-KR/README.md2
-rw-r--r--docs/ko-KR/config/README.md594
-rw-r--r--docs/nl-NL/config/README.md594
-rw-r--r--docs/pl-PL/config/README.md594
-rw-r--r--docs/pt-BR/README.md2
-rw-r--r--docs/pt-BR/config/README.md602
-rw-r--r--docs/pt-PT/config/README.md594
-rw-r--r--docs/ru-RU/README.md2
-rw-r--r--docs/ru-RU/advanced-config/README.md2
-rw-r--r--docs/ru-RU/config/README.md1068
-rw-r--r--docs/tr-TR/README.md2
-rw-r--r--docs/tr-TR/config/README.md594
-rw-r--r--docs/tr-TR/guide/README.md2
-rw-r--r--docs/vi-VN/README.md2
-rw-r--r--docs/vi-VN/advanced-config/README.md2
-rw-r--r--docs/vi-VN/config/README.md1186
-rw-r--r--docs/zh-CN/README.md2
-rw-r--r--docs/zh-CN/advanced-config/README.md2
-rw-r--r--docs/zh-CN/config/README.md940
-rw-r--r--docs/zh-CN/faq/README.md24
-rw-r--r--docs/zh-CN/installing/README.md16
-rw-r--r--docs/zh-TW/README.md2
-rw-r--r--docs/zh-TW/advanced-config/README.md2
-rw-r--r--docs/zh-TW/config/README.md912
37 files changed, 7097 insertions, 6654 deletions
diff --git a/docs/ar-SA/config/README.md b/docs/ar-SA/config/README.md
index cb488c9f9..2c432f899 100644
--- a/docs/ar-SA/config/README.md
+++ b/docs/ar-SA/config/README.md
@@ -3,7 +3,7 @@
To get started configuring starship, create the following file: `~/.config/starship.toml`.
```sh
-mkdir -p ~/.config && starship print-config --default > ~/.config/starship.toml
+mkdir -p ~/.config && touch ~/.config/starship.toml
```
All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file:
@@ -49,9 +49,9 @@ $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp"
### Terminology
-**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of NodeJS that is currently installed on your computer, if your current directory is a NodeJS project.
+**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of Node.js that is currently installed on your computer, if your current directory is a Node.js project.
-**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of NodeJS.
+**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of Node.js.
By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix.
@@ -384,7 +384,7 @@ The character will tell you whether the last command was successful or not. It c
- changing color (`red`/`green`)
- changing shape (`❯`/`✖`)
-By default it only changes color. If you also want to change it's shape take a look at [this example](#with-custom-error-shape).
+By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape).
::: warning `error_symbol` is not supported on elvish shell. :::
@@ -437,22 +437,23 @@ vicmd_symbol = "[V](bold green) "
## CMake
-The `cmake` module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met:
+The `cmake` module shows the currently installed version of [CMake](https://cmake.org/). By default the module will be activated if any of the following conditions are met:
- The current directory contains a `CMakeLists.txt` file
- The current directory contains a `CMakeCache.txt` file
### Options
-| Option | Default | Description |
-| ------------------- | -------------------------------------- | -------------------------------------------- |
-| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
-| `symbol` | `"△ "` | The symbol used before the version of cmake. |
-| `detect_extensions` | `[]` | Which extensions should trigger this module |
-| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
-| `detect_folders` | `[]` | Which folders should trigger this module |
-| `style` | `"bold blue"` | The style for the module. |
-| `disabled` | `false` | Disables the `cmake` module. |
+| Option | Default | Description |
+| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- |
+| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
+| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `"△ "` | The symbol used before the version of cmake. |
+| `detect_extensions` | `[]` | Which extensions should trigger this module |
+| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
+| `detect_folders` | `[]` | Which folders should trigger this module |
+| `style` | `"bold blue"` | The style for the module. |
+| `disabled` | `false` | Disables the `cmake` module. |
### Variables
@@ -555,22 +556,23 @@ format = "[$symbol$environment](dimmed green) "
## Crystal
-The `crystal` module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met:
+The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `shard.yml` file
- The current directory contains a `.cr` file
### Options
-| Option | Default | Description |
-| ------------------- | ------------------------------------ | --------------------------------------------------------- |
-| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
-| `style` | `"bold red"` | The style for the module. |
-| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
-| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
-| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
-| `disabled` | `false` | Disables the `crystal` module. |
+| Option | Default | Description |
+| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
+| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
+| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
+| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `style` | `"bold red"` | The style for the module. |
+| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
+| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
+| `detect_folders` | `[]` | Which folders should trigger this module. |
+| `disabled` | `false` | Disables the `crystal` module. |
### Variables
@@ -593,7 +595,7 @@ format = "via [✨ $version](bold blue) "
## Dart
-The `dart` module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met:
+The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.dart` extension
- The current directory contains a `.dart_tool` directory
@@ -601,15 +603,16 @@ The `dart` module shows the currently installed version of Dart. By default the
### Options
-| Option | Default | Description |
-| ------------------- | ------------------------------------------------- | ----------------------------------------------- |
-| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
-| `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
-| `detect_extensions` | `['dart']` | Which extensions should trigger this module. |
-| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
-| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. |
-| `style` | `"bold blue"` | The style for the module. |
-| `disabled` | `false` | Disables the `dart` module. |
+| Option | Default | Description |
+| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- |
+| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
+| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
+| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. |
+| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
+| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. |
+| `style` | `"bold blue"` | The style for the module. |
+| `disabled` | `false` | Disables the `dart` module. |
### Variables
@@ -632,20 +635,21 @@ format = "via [🔰 $version](bold red) "
## Deno
-The `deno` module shows you your currently installed version of Deno. By default the module will be shown if any of the following conditions are met:
+The `deno` module shows you your currently installed version of [Deno](https://deno.land/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file
### Options
-| Option | Default | Description |
-| ------------------- | -------------------------------------------- | ----------------------------------------------- |
-| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
-| `symbol` | `"🦕 "` | A format string representing the symbol of Deno |
-| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. |
-| `detect_folders` | `[]` | Which folders should trigger this module. |
-| `style` | `"green bold"` | The style for the module. |
-| `disabled` | `false` | Disables the `deno` module. |
+| Option | Default | Description |
+| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- |
+| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
+| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `"🦕 "` | A format string representing the symbol of Deno |
+| `detect_extensions` | `[]` | Which extensions should trigger this module. |
+| `detect_files` | `["mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. |
+| `detect_folders` | `[]` | Which folders should trigger this module. |
+| `style` | `"green bold"` | The style for the module. |
+| `disabled` | `false` | Disables the `deno` module. |
### Variables
@@ -764,7 +768,7 @@ format = "via [🐋 $context](blue bold)"
## Dotnet
-The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK.
+The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK.
By default this module will only be shown in your prompt when one or more of the following files are present in the current directory:
@@ -786,16 +790,17 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
### Options
-| Option | Default | Description |
-| ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- |
-| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. |
-| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. |
-| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
-| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
-| `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. |
-| `detect_folders` | `[]` | Which folders should trigger this modules. |
-| `style` | `"bold blue"` | The style for the module. |
-| `disabled` | `false` | Disables the `dotnet` module. |
+| Option | Default | Description |
+| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
+| `format` | `"[$symbol($version )(🎯 $tfm )]($style)"` | The format for the module. |
+| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. |
+| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
+| `detect_extensions` | `["sln", "csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
+| `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. |
+| `detect_folders` | `[]` | Which folders should trigger this modules. |
+| `style` | `"bold blue"` | The style for the module. |
+| `disabled` | `false` | Disables the `dotnet` module. |
### Variables
@@ -821,21 +826,22 @@ heuristic = false
## Elixir
-The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. By default the module will be shown if any of the following conditions are met:
+The `elixir` module shows the currently installed version of [Elixir](https://elixir-lang.org/) and [Erlang/OTP](https://erlang.org/doc/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `mix.exs` file.
### Options
-| Option | Default | Description |
-| ------------------- | ----------------------------------------------------------- | --------------------------------------------------------------- |
-| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
-| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
-| `detect_folders` | `[]` | Which folders should trigger this modules. |
-| `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 |
+| ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------- |
+| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
+| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
+| `detect_extensions` | `[]` | Which extensions should trigger this module. |
+| `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
+| `detect_folders` | `[]` | Which folders should trigger this modules. |
+| `style` | `"bold purple"` | The style for the module. |
+| `disabled` | `false` | Disables the `elixir` module. |
### Variables
@@ -859,7 +865,7 @@ symbol = "🔮 "
## Elm
-The `elm` module shows the currently installed version of Elm. By default the module will be shown if any of the following conditions are met:
+The `elm` module shows the currently installed version of [Elm](https://elm-lang.org/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `elm.json` file
- The current directory contains a `elm-package.json` file
@@ -869,15 +875,16 @@ The `elm` module shows the currently installed version of Elm. By default the mo
### Options
-| Option | Default | Description |
-| ------------------- | -------------------------------------------------- | ----------------------------------------------- |
-| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
-| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
-| `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
-| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
-| `detect_folders` | `["elm-stuff"]` | Which folders should trigger this modules. |
-| `style` | `"cyan bold"` | The style for the module. |
-| `disabled` | `false` | Disables the `elm` module. |
+| Option | Default | Description |
+| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------- |
+| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
+| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
+| `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
+| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
+| `detect_folders` | `["elm-stuff"]` | Which folders should trigger this modules. |
+| `style` | `"cyan bold"` | The style for the module. |
+| `disabled` | `false` | Disables the `elm` module. |
### Variables
@@ -937,22 +944,23 @@ default = "unknown shell"
## Erlang
-The `erlang` module shows the currently installed version of Erlang/OTP. By default the module will be shown if any of the following conditions are met:
+The `erlang` module shows the currently installed version of [Erlang/OTP](https://erlang.org/doc/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `rebar.config` file.
- The current directory contains a `erlang.mk` file.
### Options
-| Option | Default | Description |
-| ------------------- | ------------------------------------ | -------------------------------------------------------- |
-| `symbol` | `" "` | The symbol used before displaying the version of erlang. |
-| `style` | `"bold red"` | The style for the module. |
-| `detect_extensions` | `[]` | Which extensions should trigger this module. |
-| `detect_files` | `["rebar.config", "elang.mk"]` | Which filenames should trigger this module. |
-| `detect_folders` | `[]` | Which folders should trigger this modules. |
-| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
-| `disabled` | `false` | Disables the `erlang` module. |
+| Option | Default | Description |
+| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
+| `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
+| `version_format` | `v{raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
+| `symbol` | `" "` | The symbol used before displaying the version of erlang. |
+| `style` | `"bold red"` | The style for the module. |
+| `detect_extensions` | `[]` | Which extensions should trigger this module. |
+| `detect_files` | `["rebar.config", "elang.mk"]` | Which filenames should trigger this module. |
+| `detect_folders` | `[]` | Which folders should trigger this modules. |
+| `disabled` | `false` | Disables the `erlang` module. |
### Variables
@@ -979,24 +987,25 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud
### Options
-| 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. |
+| Option | Default | Description |
+| ---------------- | ---------------------------------------------------------- | --------------------------------------------------------------- |
+| `format` | `'on [$symbol$account(@$domain)(\($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
-| Variable | Example | Description |
-| --------- | ----------------- | ------------------------------------------------------------------ |
-| region | `us-central1` | The current GCP region |
-| account | `foo@example.com` | The current GCP profile |
-| project | | The current GCP project |
-| active | `default` | The active config name written in `~/.config/gcloud/active_config` |
-| symbol | | Mirrors the value of option `symbol` |
-| style\* | | Mirrors the value of option `style` |
+| Variable | Example | Description |
+| --------- | ------------- | ------------------------------------------------------------------ |
+| region | `us-central1` | The current GCP region |
+| account | `foo` | The current GCP profile |
+| domain | `example.com` | The current GCP profile domain |
+| project | | The current GCP project |
+| active | `default` | The active config name written in `~/.config/gcloud/active_config` |
+| 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
@@ -1008,7 +1017,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud
# ~/.config/starship.toml
[gcloud]
-format = 'on [$symbol$account(\($project\))]($style) '
+format = 'on [$symbol$account(@$domain)(\($project\))]($style) '
```
#### Display active config name only
@@ -1233,7 +1242,7 @@ behind = "⇣${count}"
## Golang
-The `golang` module shows the currently installed version of Golang. By default the module will be shown if any of the following conditions are met:
+The `golang` module shows the currently installed version of [Golang](https://golang.org/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `go.mod` file
- The current directory contains a `go.sum` file
@@ -1246,15 +1255,16 @@ The `golang` module shows the currently installed version of Golang. By default
### Options
-| Option | Default | Description |
-| ------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------- |
-| `format` | `"via [$symbol($version )]($style)"` | The format for the