summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorAndrew Dassonville <dassonville.andrew@gmail.com>2019-07-28 18:05:13 -0700
committerMatan Kushner <hello@matchai.me>2019-07-28 21:05:13 -0400
commit5dbf4381acd1fd8dbb2905828c3fcc6515d850cf (patch)
tree36a13ea34b8af9c0f6c5fa30c8ae9d7c3835f0de /docs
parentab46710fc47891a80eb1b6073616c95a1acc92bd (diff)
feat: Allow directory truncation length to be configured (#120)
This allows the directory truncation length to be configured. Previously, it was hard-coded to truncate to 3 parent directories.
Diffstat (limited to 'docs')
-rw-r--r--docs/config/README.md16
1 files changed, 13 insertions, 3 deletions
diff --git a/docs/config/README.md b/docs/config/README.md
index fdcb07aea..bca949c52 100644
--- a/docs/config/README.md
+++ b/docs/config/README.md
@@ -116,9 +116,19 @@ git repo that you're currently in.
### Options
-| Variable | Default | Description |
-| ---------- | ------- | -------------------------------- |
-| `disabled` | `false` | Disables the `directory` module. |
+| Variable | Default | Description |
+| ------------------- | ------- | -------------------------------------- |
+| `truncation_length` | `3` | Truncates to this many parent folders. |
+| `disabled` | `false` | Disables the `directory` module. |
+
+### Example
+
+```toml
+# ~/.config/starship.toml
+
+[directory]
+truncation_length = 8
+```
## Git Branch