extern/starship
1
0
Fork 0
mirror of https://github.com/starship/starship.git synced 2025-02-02 19:39:52 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Clarify wording on add_newline option (#2308)

Browse Source 
* docs: Clarify wording on add_newline option

* docs: Replace new line with blank line
This commit is contained in:
Artur Daschevici 2021-02-23 17:50:36 +00:00 committed by GitHub
parent 36351e4b2f
commit 5a29765f81
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/config/README.md
View File

@ -9,8 +9,8 @@ mkdir -p ~/.config && touch ~/.config/starship.toml
All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file: All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file:
```toml ```toml
# Don't print a new line at the start of the prompt # Inserts a blank line between shell prompts
add_newline = false add_newline = true
# Replace the "❯" symbol in the prompt with "➜" # Replace the "❯" symbol in the prompt with "➜"
[character] # The name of the module we are configuring is "character" [character] # The name of the module we are configuring is "character"
@ -155,7 +155,7 @@ This is the list of prompt-wide configuration options.
| -------------- | ------------------------------ | ----------------------------------------------------- | | -------------- | ------------------------------ | ----------------------------------------------------- |
| `format` | [link](#default-prompt-format) | Configure the format of the prompt. | | `format` | [link](#default-prompt-format) | Configure the format of the prompt. |
| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). | | `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
| `add_newline` | `true` | Add a new line before the start of the prompt. | | `add_newline` | `true` | Inserts blank line between shell prompts. |
### Example ### Example
@ -171,7 +171,7 @@ format = """
# Wait 10 milliseconds for starship to check files under the current directory. # Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10 scan_timeout = 10
# Disable the newline at the start of the prompt # Disable the blank line at the start of the prompt
add_newline = false add_newline = false
``` ```