summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorMatan Kushner <hello@matchai.me>2020-01-15 12:23:25 -0500
committerGitHub <noreply@github.com>2020-01-15 12:23:25 -0500
commitddfcee38095ea117341cd4c6744d74511b33190a (patch)
tree8afdab09d9feab7ca8f95c1f8be34cd9d672f814 /docs
parent1f9059c6110394ce21be9b5eda08904174f7400d (diff)
docs(i18n): Update translated docs (#792)
Diffstat (limited to 'docs')
-rw-r--r--docs/de-DE/config/README.md22
-rw-r--r--docs/de-DE/guide/README.md23
-rw-r--r--docs/es-ES/README.md114
-rw-r--r--docs/es-ES/advanced-config/README.md84
-rw-r--r--docs/es-ES/config/README.md1038
-rw-r--r--docs/es-ES/faq/README.md45
-rw-r--r--docs/es-ES/guide/README.md351
-rw-r--r--docs/es-ES/presets/README.md61
-rw-r--r--docs/fr-FR/config/README.md8
-rw-r--r--docs/fr-FR/guide/README.md19
-rw-r--r--docs/ja-JP/README.md12
-rw-r--r--docs/ja-JP/config/README.md52
-rw-r--r--docs/ja-JP/guide/README.md73
-rw-r--r--docs/ja-JP/presets/README.md16
-rw-r--r--docs/ru-RU/config/README.md176
-rw-r--r--docs/ru-RU/guide/README.md25
-rw-r--r--docs/zh-CN/advanced-config/README.md4
-rw-r--r--docs/zh-CN/config/README.md6
-rw-r--r--docs/zh-CN/guide/README.md23
-rw-r--r--docs/zh-TW/config/README.md6
-rw-r--r--docs/zh-TW/guide/README.md23
21 files changed, 2000 insertions, 181 deletions
diff --git a/docs/de-DE/config/README.md b/docs/de-DE/config/README.md
index b85f4d903..8b7b7eed3 100644
--- a/docs/de-DE/config/README.md
+++ b/docs/de-DE/config/README.md
@@ -27,6 +27,11 @@ symbol = "➜" # Das "symbol" Feld wird "➜" gesetzt
disabled = true
```
+You can change default `starship.toml` file location with `STARSHIP_CONFIG` environment variable:
+```shell
+export STARSHIP_CONFIG=~/.starship
+```
+
### Terminologie
**Module**: Eine Komponente in der Konsole, die auf kontextualisierte Informationen des OS basiert. Zum Beispiel zeigt das Modul "nodejs" die Version von NodeJS, die derzeit auf Ihrem Computer installiert ist, wenn Ihr aktuelles Verzeichnis ein NodeJS-Projekt ist.
@@ -499,6 +504,7 @@ The `git_status` module shows symbols representing the state of the repo in your
| `untracked` | `"?"` | There are untracked files in the working directory. |
| `untracked_count` | [link](#git-status-counts) | Show and style the number of untracked files. |
| `stashed` | `"$"` | A stash exists for the local repository. |
+| `stashed_count` | [link](#git-status-counts) | Show and style the number of stashes. |
| `modified` | `"!"` | There are file modifications in the working directory. |
| `modified_count` | [link](#git-status-counts) | Show and style the number of modified files. |
| `staged` | `"+"` | A new file has been added to the staging area. |
@@ -783,7 +789,7 @@ style = "bold dimmed green"
## NodeJS
-Das `nodejs`-Modul zeigt die aktuell installierte Version von NodeJS. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
+Das `nodejs` Modul zeigt die derzeit installierte Version von NodeJS. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft:
- Das aktuelle Verzeichnis enthält eine `package.json`-Datei
- Das aktuelle Verzeichnis enthält ein `node_modules`-Verzeichnis
@@ -836,7 +842,7 @@ symbol = "🎁 "
## PHP
-Das `php`-Modul zeigt die aktuell installierte Version von PHP. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
+Das `php`-Modul zeigt die aktuell installierte Version von PHP. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft:
- Das aktuelle Verzeichnis enthält eine `composer.json`-Datei
- Das aktuelle Verzeichnis enthält eine `.php`-Datei
@@ -866,7 +872,7 @@ Wenn `pyenv_version_name` auf `true` gesetzt ist, wird die version der pyenv ang
Andernfalls wird die gleiche Versionsnummer angezeigt wie `python --version`, sowie der Name des aktuellen virtualenvs, wenn eines aktiv ist.
-Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
+Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft:
- Das aktuelle Verzeichnis enthält eine `.python-version`-Datei
- Das aktuelle Verzeichnis enthält eine `requirements.txt`-Datei
@@ -923,7 +929,7 @@ symbol = "🔺 "
## Rust
-Das `rust` Modul zeigt die derzeit installierte Version von Rust an. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
+Das `rust` Modul zeigt die derzeit installierte Version von Rust an. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft:
- Das aktuelle Verzeichnis enthält eine `Cargo.toml`-Datei
- Das aktuelle Verzeichnis enthält eine Datei mit der `.rs`-Erweiterung
@@ -947,7 +953,7 @@ symbol = "⚙️ "
## Terraform
-Das `Terraform` Modul zeigt den aktuell ausgewählten terraform Arbeitsbereich und die Version an. Standardmäßig wird die Terraform-Version nicht angezeigt, da dies bei aktuellen Versionen von Terraform langsam ist, wenn viele Plugins verwendet werden. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
+Das `Terraform` Modul zeigt den aktuell ausgewählten terraform Arbeitsbereich und die Version an. Standardmäßig wird die Terraform-Version nicht angezeigt, da dies bei aktuellen Versionen von Terraform langsam ist, wenn viele Plugins verwendet werden. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft:
- Das aktuelle Verzeichnis enthält eine `.terraform`-Datei
- Das aktuelle Verzeichnis enthält eine Datei mit der `.tf`-Erweiterung
@@ -974,7 +980,7 @@ symbol = "🏎💨 "
Das `time` Modul zeigt die aktuelle **lokale** Zeit an. Der `format` Wert wird von der crate [`chrono`](https://crates.io/crates/chrono) benutzt um die Zeit zu formatieren. Schau dir [die chrono strftime Dokumentation](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) an, um die möglichen Optionen zu sehen.
-::: Tipp
+::: tip
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
@@ -990,7 +996,7 @@ Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `dis
| `utc_time_offset` | `lokal` | Legt das UTC-Offset fest, das verwendet werden soll. Reicht von -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. |
| `disabled` | `true` | Deaktiviert das `time`-Modul. |
-Wird `use_12hr` auf `true` gestellt, nimmt `format` automatisch den Wert `"%r"` an. Andernfalls ist es standardmäßig `"%T"`. Wird hingegen `format` gesetzt, so überschreibt dies die Einstellung `use_12hr`.
+Wird `use_12hr` auf `true` gestellt, so wird `format` automatisch auf `"%r"` gesetzt. Ansonsten ist der Standardwert hierfür `"%T"`. Wird hingegen `format` gesetzt, so überschreibt dies die Einstellung `use_12hr`.
### Beispiel
@@ -1005,7 +1011,7 @@ utc_time_offset = -5
## Username
-Das `username` Modul zeigt den Namen des aktiven Benutzers. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
+Das Modul `username` zeigt den Benutzernamen des aktiven Benutzers. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft:
- Der aktuelle Benutzer ist root
- Der aktuelle Benutzer ist nicht der eingeloggte Benutzer
diff --git a/docs/de-DE/guide/README.md b/docs/de-DE/guide/README.md
index 9338133fc..dbc4f6ee6 100644
--- a/docs/de-DE/guide/README.md
+++ b/docs/de-DE/guide/README.md
@@ -21,7 +21,7 @@
src="https://img.shields.io/discord/567163873606500352?logo=discord"
alt="Auf Discord chatten" /></a>
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
-<a href="#contributors"><img src="https://img.shields.io/badge/all%20contributors-63-orange" alt="Alle Mitwirkenden"></a>
+<a href="#contributors"><img src="https://img.shields.io/badge/all%20contributors-64-orange" alt="Alle Mitwirkenden"></a>
<!-- ALL-CONTRIBUTORS-BADGE:END -->
</p>
@@ -49,6 +49,9 @@
<a href="https://translate.starship.rs/project/starship-prompt/de"
><img height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-de.png" alt="Deutsch" /></a>
&nbsp;
+ <a href="https://translate.starship.rs/project/starship-prompt/es"
+ ><img height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-es.png" alt="Español" /></a>
+ &nbsp;
<a href="https://translate.starship.rs/project/starship-prompt/fr"
><img height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png" alt="Français" /></a>
&nbsp;
@@ -71,8 +74,8 @@
- Anzeigetext wird rot wenn der letzte Befehl mit einem Exit-code größer null terminiert
- Derzeitige Go-Version (`🐹`)
-- Derzeitige Java-Version (`☕`)
-- Derzeitige Node.js-Version (`⬢`)
+- Current Java version (`☕`)
+- Current Node.js version (`⬢`)
- Current PHP version (`🐘`)
- Derzeitige Python-Version (`🐍`)
- Derzeitige Ruby-Version (`💎`)
@@ -122,13 +125,20 @@
#### Install Latest Version
- ##### With Shell:
+ ##### From prebuilt binary, with Shell:
```sh
curl -fsSL https://starship.rs/install.sh | bash
```
+ ##### From source on [crates.io](https://crates.io/):
+
+ ```sh
+ cargo install starship
+ ```
+
+
#### Install via Package Manager
@@ -292,7 +302,7 @@ Danke an diese wunderbaren Leute ([emoji-Schlüssel](https://allcontributors.org
<td align="center"><a href="https://github.com/pinshan"><img src="https://avatars0.githubusercontent.com/u/7709675?v=4" width="100px;" alt="" /><br /><sub><b>pinshan</b></sub></a><br /><a href="#translation-pinshan" title="Translation">🌍</a></td>
<td align="center"><a href="https://github.com/brianlow"><img src="https://avatars2.githubusercontent.com/u/938138?v=4" width="100px;" alt="" /><br /><sub><b>Brian Low</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=brianlow" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=brianlow" title="Documentation">📖</a> <a href="https://github.com/starship/starship/commits?author=brianlow" title="Tests">⚠️</a></td>
<td align="center"><a href="http://matiaskotlik.github.io"><img src="https://avatars2.githubusercontent.com/u/20362627?v=4" width="100px;" alt="" /><br /><sub><b>Matias Kotlik</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=matiaskotlik" title="Code">💻</a></td>
- <td align="center"><a href="https://marblenix.com"><img src="https://avatars0.githubusercontent.com/u/6401427?v=4" width="100px;" alt="" /><br /><sub><b>marblenix</b></sub></a><br /><a href="#infra-marblenix" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
+ <td align="center"><a href="https://marblenix.com"><img src="https://avatars0.githubusercontent.com/u/6401427?v=4" width="100px;" alt="" /><br /><sub><b>marblenix</b></sub></a><br /><a href="#infra-marblenix" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/starship/starship/commits?author=marblenix" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=marblenix" title="Tests">⚠️</a></td>
</tr>
<tr>
<td align="center"><a href="https://github.com/weirongxu"><img src="https://avatars3.githubusercontent.com/u/1709861?v=4" width="100px;" alt="" /><br /><sub><b>Raidou</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=weirongxu" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=weirongxu" title="Tests">⚠️</a></td>
@@ -312,6 +322,9 @@ Danke an diese wunderbaren Leute ([emoji-Schlüssel](https://allcontributors.org
<td align="center"><a href="http://sda.io"><img src="https://avatars1.githubusercontent.com/u/481987?v=4" width="100px;" alt="" /><br /><sub><b>Mike Sampson</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=mfs" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=mfs" title="Documentation">📖</a> <a href="https://github.com/starship/starship/commits?author=mfs" title="Tests">⚠️</a></td>
<td align="center"><a href="https://sternentstehung.de"><img src="https://avatars3.githubusercontent.com/u/36575275?v=4" width="100px;" alt="" /><br /><sub><b>Dominik Braun</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=dominikbraun" title="Code">💻</a></td>
</tr>
+ <tr>
+ <td align="center"><a href="https://github.com/dten"><img src="https://avatars0.githubusercontent.com/u/1019038?v=4" width="100px;" alt="" /><br /><sub><b>David Hewson</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=dten" title="Code">💻</a></td>
+ </tr>
</table>
<!-- markdownlint-enable -->
diff --git a/docs/es-ES/README.md b/docs/es-ES/README.md
new file mode 100644
index 000000000..7ddac16e0
--- /dev/null
+++ b/docs/es-ES/README.md
@@ -0,0 +1,114 @@
+---
+home: true
+heroImage: /logo.svg
+actionText: Empezar →
+actionLink: /guide/
+footer: Bajo una licencia ISC | Derechos de autor © 2019-presente Colaboradores de Starship
+---
+
+<div class="features">
+ <div class="feature">
+ <h2>Compatibilidad primero</h2>
+ <p>Funciona en las interfaces de líneas de comando (shells) más comunes en los sistemas operativos más comunes. ¡Úsalo donde sea!</p>
+ </div>
+ <div class="feature">
+ <h2>Desarrollado en Rust</h2>
+ <p>Obtén la mayor velocidad y seguridad de Rust, para hacer tu prompt lo más rápida y segura posible.</p>
+ </div>
+ <div class="feature">
+ <h2>Personalizable</h2>
+ <p>Puedes personalizar cada pequeño detalle a tu gusto, de manera que puedes tener una interfaz minimalista o rica en funcionalidades.</p>
+ </div>
+</div>
+
+<div class="center">
+ <video class="demo-video" muted autoplay loop playsinline>
+ <source src="/demo.webm" type="video/webm">
+ <source src="/demo.mp4" type="video/mp4">
+ </video>
+</div>
+
+### Instalación rápida
+
+1. Instalar el binario de **starship**:
+
+
+ #### Instalar la última versión
+
+ Con la interfaz de línea de comandos:
+
+ ```sh
+ curl -fsSL https://starship.rs/install.sh | bash
+ ```
+
+
+ #### Instalar con un gestor de paquetes
+
+ Con [Homebrew](https://brew.sh/):
+
+ ```sh
+ brew install starship
+ ```
+
+ Con [Scoop](https://scoop.sh):
+
+ ```powershell
+ scoop install starship
+ ```
+
+1. Añade el script de inicio al archivo de configuración de tu interfaz de línea de comandos:
+
+
+ #### Bash
+
+ Añade el siguiente código al final de `~/.bashrc`:
+
+ ```sh
+ # ~/.bashrc
+
+ eval "$(starship init bash)"
+ ```
+
+
+ #### Fish
+
+ Añade el siguiente código al final de `~/.config/fish/config.fish`:
+
+ ```sh
+ # ~/.config/fish/config.fish
+
+ starship init fish | source
+ ```
+
+
+ #### Zsh
+
+ Añade el siguiente código al final de `~/.zshrc`:
+
+ ```sh
+ # ~/.zshrc
+
+ eval "$(starship init zsh)"
+ ```
+
+
+ #### Powershell
+
+ Añade el siguiente código al final de `~\Documentos\PowerShell\Microsoft.PowerShell_profile.ps1` (o `~/.config/powershell/Microsoft.PowerShell_profile.ps1` en sistemas *nix):
+
+ ```sh
+ # ~\Documentos\PowerShell\Profile.ps1
+
+ Invoke-Expression (&starship init powershell)
+ ```
+
+
+ #### Ion
+
+ Añade el siguiente código al final de `~/.config/ion/initrc`:
+
+ ```sh
+ # ~/.config/ion/initrc
+
+ eval $(starship init ion)
+ ```
diff --git a/docs/es-ES/advanced-config/README.md b/docs/es-ES/advanced-config/README.md
new file mode 100644
index 000000000..d5d27031f
--- /dev/null
+++ b/docs/es-ES/advanced-config/README.md
@@ -0,0 +1,84 @@
+# Advanced Configuration
+
+While Starship is a versatile shell, sometimes you need to do more than edit `starship.toml` to get it to do certain things. This page details some of the more advanced configuration techniques used in starship.
+
+::: warning
+
+The configurations in this section are subject to change in future releases of Starship.
+
+:::
+
+## Custom pre-prompt and pre-execution Commands in Bash
+
+Bash does not have a formal preexec/precmd framework like most other shells. Because of this, it is difficult to provide fully customizable hooks in `bash`. However, Starship does give you limited ability to insert your own functions into the prompt-rendering procedure:
+
+- To run a custom function right before the prompt is drawn, define a new function and then assign its name to `starship_precmd_user_func`. For example, to draw a rocket before the prompt, you would do
+
+```bash
+function blastoff(){
+ echo "🚀"
+}
+starship_precmd_user_func="blastoff"
+```
+
+- To run a custom function right before a command runs, you can use the [`DEBUG` trap mechanism](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/). However, you **must** trap the DEBUG signal *before* initializing Starship! Starship can preserve the value of the DEBUG trap, but if the trap is overwritten after starship starts up, some functionality will break.
+
+```bash
+function blastoff(){
+ echo "🚀"
+}
+trap blastoff DEBUG # Trap DEBUG *before* running starship
+eval $(starship init bash)
+```
+
+## Change Window Title
+
+Some shell prompts will automatically change the window title for you (e.g. to reflect your working directory). Fish even does it by default. Starship does not do this, but it's fairly straightforward to add this functionality to `bash` or `zsh`.
+
+First, define a window title change function (identical in bash and zsh):
+
+```bash
+function set_win_title(){
+ echo -ne "\033]0; YOUR_WINDOW_TITLE_HERE \007"
+}
+```
+
+You can use variables to customize this title (`$USER`, `$HOSTNAME`, and `$PWD` are popular choices).
+
+In `bash`, set this function to be the precmd starship function:
+
+```bash
+starship_precmd_user_func="set_win_title"
+```
+
+In `zsh`, add this to the `precmd_functions` array:
+
+```bash
+precmd_functions+=(set_win_title)
+```
+
+If you like the result, add these lines to your shell configuration file (`~/.bashrc` or `~/.zsrhc`) to make it permanent.
+
+## Style Strings
+
+Style strings are a list of words, separated by whitespace. The words are not case sensitive (i.e. `bold` and `BoLd` are considered the same string). Each word can be one of the following:
+
+ - `bold`
+ - `underline`
+ - `dimmed`
+ - `bg:<color>`
+ - `fg:<color>`
+ - `<color>`
+ - `none`
+
+where `<color>` is a color specifier (discussed below). `fg:<color>` and `<color>` currently do the same thing , though this may change in the future. The order of words in the string does not matter.
+
+The `none` token overrides all other tokens in a string, so that e.g. `fg:red none fg:blue` will still create a string with no styling. It may become an error to use `none` in conjunction with other tokens in the future.
+
+A color specifier can be one of the following:
+
+ - One of the standard terminal colors: `black`, `red`, `green`, `blue`, `yellow`, `purple`, `cyan`, `white`. You can optionally prefix these with `bright-` to get the bright version (e.g. `bright-white`).
+ - A `#` followed by a six-digit hexadecimal number. This specifies an [RGB color hex code](https://www.w3schools.com/colors/colors_hexadecimal.asp).
+ - A number between 0-255. This specifies an [8-bit ANSI Color Code](https://i.stack.imgur.com/KTSQa.png).
+
+If multiple colors are specified for foreground/background, the last one in the string will take priority.
diff --git a/docs/es-ES/config/README.md b/docs/es-ES/config/README.md
new file mode 100644
index 000000000..2c225f0ca
--- /dev/null
+++ b/docs/es-ES/config/README.md
@@ -0,0 +1,1038 @@
+# Configuración
+
+::: tip
+
+🔥 Configuration is currently being worked on. Many new configuration options will be available in coming releases.
+
+:::
+
+To get started configuring starship, create the following file: `~/.config/starship.toml`.
+
+```shell
+$ mkdir -p ~/.config && touch ~/.config/starship.toml
+```
+
+All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file:
+
+```toml
+# Don't print a new line at the start of the prompt
+add_newline = false
+
+# Replace the "❯" symbol in the prompt with "➜"
+[character] # The name of the module we are configuring is "character"
+symbol = "➜" # The "symbol" segment is being set to "➜"
+
+# Disable the package module, hiding it from the prompt completely
+[package]
+disabled = true
+```
+
+You can change default `starship.toml` file location with `STARSHIP_CONFIG` environment variable:
+```shell
+export STARSHIP_CONFIG=~/.starship
+```
+
+### 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.
+
+**Segment**: Smaller sub-components that compose a module. For example, the "symbol" segment in the "nodejs" module contains the character that is shown before the version number (⬢ by default).
+
+Here is the representation of the node module. In the following example, "symbol" and "version" are segments within it. Every module also has a prefix and suffix that are the default terminal color.
+
+```
+[prefix] [symbol] [version] [suffix]
+ "via " "⬢" "v10.4.1" ""
+```
+
+### Style Strings
+
+Most modules in starship allow you to configure their display styles. This is done with an entry (usually called `style`) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the [advanced config guide](/advanced-config/).
+
+- `"fg:green bg:blue"` sets green text on a blue background
+- `"bg:blue fg:bright-green"` sets bright green text on a blue background
+- `"bold fg:27"` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
+- `"underline bg:#bf5700"` sets underlined text on a burnt orange background
+- `"bold italic fg:purple"` sets bold italic purple text
+- `""` explicitly disables all styling
+
+Note that what styling looks like will be controlled by your terminal emulator. For example, some terminal emulators will brighten the colors instead of bolding text, and some color themes use the same values for the normal and bright colors. Also, to get italic text, your terminal must support italics.
+
+## Prompt
+
+This is the list of prompt-wide configuration options.
+
+### Options
+
+| Variable | Default | Description |
+| -------------- | ----------------------------- | ------------------------------------------------------ |
+| `add_newline` | `true` | Add a new line before the start of the prompt. |
+| `prompt_order` | [link](#default-prompt-order) | Configure the order in which the prompt module occurs. |
+| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+# Disable the newline at the start of the prompt
+add_newline = false
+# Overwrite a default_prompt_order and use custom prompt_order
+prompt_order=["rust","line_break","package","line_break","character"]
+# Wait 10 milliseconds for starship to check files under the current directory.
+scan_timeout = 10
+```
+
+### Default Prompt Order
+
+The default `prompt_order` is used to define the order in which modules are shown in the prompt, if empty or no `prompt_order` is provided. The default is as shown:
+
+```toml
+prompt_order = [
+ "username",
+ "hostname",
+ "kubernetes",
+ "directory",
+ "git_branch",
+ "git_commit",
+ "git_state",
+ "git_status",
+ "hg_branch",
+ "package",
+ "dotnet",
+ "golang",
+ "java",
+ "nodejs",
+ "php",
+ "python",
+ "ruby",
+ "rust",
+ "terraform",
+ "nix_shell",
+ "conda",
+ "memory_usage",
+ "aws",
+ "env_var",
+ "cmd_duration",
+ "line_break",
+ "jobs",
+ "battery",
+ "time",
+ "character",
+]
+```
+
+## AWS
+
+The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file.
+
+### Options
+
+| Variable | Default | Description |
+| ----------------- | --------------- | --------------------------------------------------------------------------- |
+| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
+| `displayed_items` | `all` | Choose which item to display. Possible values: [`all`, `profile`, `region`] |
+| `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. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[aws]
+style = "bold blue"
+symbol = "🅰 "
+displayed_items = "region"
+[aws.region_aliases]
+ap-southeast-2 = "au"
+us-east-1 = "va"
+```
+
+## Battery
+
+The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%.
+
+### Options
+
+| Variable | Default | Description |
+| -------------------- | ------------------------ | ------------------------------------------------- |
+| `full_symbol` | `"•"` | The symbol shown when the battery is full. |
+| `charging_symbol` | `"⇡"` | The symbol shown when the battery is charging. |
+| `discharging_symbol` | `"⇣"` | The symbol shown when the battery is discharging. |
+| `display` | [link](#battery-display) | Display threshold and style for the module. |
+| `disabled` | `false` | Disables the `battery` module. |
+
+<details>
+<summary>There are also options for some uncommon battery states.</summary>
+
+| Variable | Description |
+| ---------------- | --------------------------------------------------- |
+| `unknown_symbol` | The symbol shown when the battery state is unknown. |
+| `empty_symbol` | The symbol shown when the battery state is empty. |
+
+Note: Battery indicator will be hidden if the status is `unknown` or `empty` unless you specify the option in the config.
+
+</details>
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[battery]
+full_symbol = "🔋"
+charging_symbol = "⚡️"
+discharging_symbol = "💀"
+```
+
+### Battery Display
+
+The `display` configuration option is used to define when the battery indicator should be shown (threshold) and what it looks like (style). If no `display` is provided. The default is as shown:
+
+```toml
+[[battery.display]]
+threshold = 10
+style = "bold red"
+```
+
+#### Options
+
+The `display` option is an array of the following table.
+
+| Variable | Description |
+| ----------- | ----------------------------------------------- |
+| `threshold` | The upper bound for the display option. |
+| `style` | The style used if the display option is in use. |
+
+#### Example
+
+```toml
+[[battery.display]] # "bold red" style when capacity is between 0% and 10%
+threshold = 10
+style = "bold red"
+
+[[battery.display]] # "bold yellow" style when capacity is between 10% and 30%
+threshold = 30
+style = "bold yellow"
+
+# when capacity is over 30%, the battery indicator will not be displayed
+
+```
+
+## Character
+
+The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal.
+
+The character will tell you whether the last command was successful or not. It can do this in two ways: by changing color (red/green) or by changing its shape (❯/✖). The latter will only be done if `use_symbol_for_status` is set to `true`.
+
+### Options
+
+| Variable | Default | Description |
+| ----------------------- | -------------- | ----------------------------------------------------------------------------------- |
+| `symbol` | `"❯"` | The symbol used before the text input in the prompt. |
+| `error_symbol` | `"✖"` | The symbol used before text input if the previous command failed. |
+| `use_symbol_for_status` | `false` | Indicate error status by changing the symbol. |
+| `vicmd_symbol` | `"❮"` | The symbol used before the text input in the prompt if shell is in vim normal mode. |
+| `style_success` | `"bold green"` | The style used if the last command was successful. |
+| `style_failure` | `"bold red"` | The style used if the last command failed. |
+| `disabled` | `false` | Disables the `character` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[character]
+symbol = "➜"
+error_symbol = "✗"
+use_symbol_for_status = true
+```
+
+## Command Duration
+
+The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists.
+
+::: warning Do not hook the DEBUG trap in Bash
+
+If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break.
+
+:::
+
+Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal.
+
+### Options
+
+| Variable | Default | Description |
+| ------------------- | --------------- | ---------------------------------------------------------- |
+| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). |
+| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. |
+| `prefix` | `took` | Prefix to display immediately before the command duration. |
+| `style` | `"bold yellow"` | The style for the module. |
+| `disabled` | `false` | Disables the `cmd_duration` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[cmd_duration]
+min_time = 500
+prefix = "underwent "
+```
+
+## Conda
+
+The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set.
+
+::: tip
+
+This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`.
+
+:::
+
+### Options
+
+| Variable | Default | Description |
+| ------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `truncation_length` | `1` | The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](#directory) module. |
+| `symbol` | `"C "` | The symbol used before the environment name. |
+| `style` | `"bold green"` | The style for the module. |
+| `disabled` | `false` | Disables the `conda` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[conda]
+style = "dimmed green"
+```
+