diff options
| author | Matthew (Matt) Jeffryes <github@mjeffryes.net> | 2021-09-12 16:59:15 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-09-12 19:59:15 -0400 |
| commit | 5d0a38aca3fdc8133314bf8fc24830c8e4b9eabd (patch) | |
| tree | 4c68f189d0537a613d6aefa62c30fcd96414e40f /docs | |
| parent | 5ac7ad741fdcb199671c63ae215a06f216fa78b8 (diff) | |
feat: Add a fill module to pad out the line (#3029)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/config/README.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/config/README.md b/docs/config/README.md index c7e942668..846c06db4 100644 --- a/docs/config/README.md +++ b/docs/config/README.md @@ -1119,6 +1119,37 @@ By default the module will be shown if any of the following conditions are met: format = "via [e $version](bold red) " ``` +## Fill + +The `fill` module fills any extra space on the line with a symbol. If multiple `fill` modules are +present in a line they will split the space evenly between them. This is useful for aligning +other modules. + +### Options + +| Option | Default | Description | +| ---------- | -------------- | -------------------------------------- | +| `symbol` | `"."` | The symbol used to fill the line. | +| `style` | `"bold black"` | The style for the module. | + +### Example + +```toml +# ~/.config/starship.toml +format="AA $fill BB $fill CC" + +[fill] +symbol = "-" +style = "bold green" +``` + +Produces a prompt that looks like: + +``` +AA -------------------------------------------- BB -------------------------------------------- CC + +``` + ## Google Cloud (`gcloud`) The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. |