summaryrefslogtreecommitdiffstats
path: root/docs/config/README.md
diff options
context:
space:
mode:
authorAlper Cugun <github@alper.nl>2024-03-21 12:41:20 +0100
committerGitHub <noreply@github.com>2024-03-21 12:41:20 +0100
commite39e73190778f5c0ce58b898cec99ec799ec4854 (patch)
tree019774db3ab5277cc08a4af387419a40f7861067 /docs/config/README.md
parentdf65b2155f92c03d07cabbcee6c92104a878c963 (diff)
docs(bun): Add nodejs override to bun config documentation (#5834)
Diffstat (limited to 'docs/config/README.md')
-rw-r--r--docs/config/README.md13
1 files changed, 12 insertions, 1 deletions
diff --git a/docs/config/README.md b/docs/config/README.md
index e7c231fce..47f456760 100644
--- a/docs/config/README.md
+++ b/docs/config/README.md
@@ -645,7 +645,9 @@ By default the module will be shown if any of the following conditions are met:
*: This variable can only be used as a part of a style string
-### Example
+### Examples
+
+#### Customize the format
```toml
# ~/.config/starship.toml
@@ -654,6 +656,15 @@ By default the module will be shown if any of the following conditions are met:
format = 'via [🍔 $version](bold green) '
```
+#### Replace Node.js
+
+You can override the `detect_files` property of [the nodejs module](#nodejs) in your config so as to only show the bun runtime:
+
+```
+[nodejs]
+detect_files = ['package.json', '.node-version', '!bunfig.toml', '!bun.lockb']
+```
+
## C
The `c` module shows some information about your C compiler. By default