Document follow_symlinks

starship · Aug 15, 2023 · 02f298a · 02f298a
1 parent bfa1a29
commit 02f298a
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/docs/config/README.md b/docs/config/README.md
@@ -219,6 +219,14 @@ This is the list of prompt-wide configuration options.
 | `add_newline`     | `true`                         | Inserts blank line between shell prompts.                                                                                                                                        |
 | `palette`         | `''`                           | Sets which color palette from `palettes` to use.                                                                                                                                 |
 | `palettes`        | `{}`                           | Collection of color palettes that assign [colors](/advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. |
+| `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. |
+
+::: tip
+
+If you have symlinks to networked filesystems, consider setting
+`follow_symlinks` to `false`.
+
+:::
 
 ### Example