summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDiego Zamboni <diego@zzamboni.org>2021-05-20 21:36:48 +0200
committerGitHub <noreply@github.com>2021-05-20 15:36:48 -0400
commit5556350d8470638751c0c4ccdb3f9c54a16bfa66 (patch)
tree0804eccaacd00bfd24fd02b604db0dd61b12ed0d
parentb688356c26406e32771a33206f37b9e3ce131a70 (diff)
docs: New preset "Bracketed Segments" (#2747)
This preset changes all the built-in formats to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.).
-rw-r--r--docs/.vuepress/public/presets/bracketed-segments-after.pngbin0 -> 49534 bytes
-rw-r--r--docs/.vuepress/public/presets/bracketed-segments-before.pngbin0 -> 50661 bytes
-rw-r--r--docs/presets/README.md128
3 files changed, 128 insertions, 0 deletions
diff --git a/docs/.vuepress/public/presets/bracketed-segments-after.png b/docs/.vuepress/public/presets/bracketed-segments-after.png
new file mode 100644
index 000000000..24b4ea1ac
--- /dev/null
+++ b/docs/.vuepress/public/presets/bracketed-segments-after.png
Binary files differ
diff --git a/docs/.vuepress/public/presets/bracketed-segments-before.png b/docs/.vuepress/public/presets/bracketed-segments-before.png
new file mode 100644
index 000000000..e0fd11796
--- /dev/null
+++ b/docs/.vuepress/public/presets/bracketed-segments-before.png
Binary files differ
diff --git a/docs/presets/README.md b/docs/presets/README.md
index e3c1966b3..7b97255c1 100644
--- a/docs/presets/README.md
+++ b/docs/presets/README.md
@@ -86,3 +86,131 @@ symbol = " "
[swift]
symbol = "ﯣ "
```
+
+## Bracketed Segments
+
+This preset changes the format of all the built-in modules to show their segment
+in brackets instead of using the default Starship wording ("via", "on", etc.).
+
+Before:
+
+![Screenshot of default Starship configuration](/presets/bracketed-segments-before.png)
+
+After:
+
+![Screenshot of Bracketed Segments preset](/presets/bracketed-segments-after.png)
+
+### Configuration
+
+```toml
+[cmake]
+format = '\[[$symbol($version)]($style)\]'
+
+[cmd_duration]
+format = "[⏱ $duration]($style)"
+
+[conda]
+format = '\[[$symbol$environment]($style)\]'
+
+[crystal]
+format = '\[[$symbol($version)]($style)\]'
+
+[dart]
+format = '\[[$symbol($version)]($style)\]'
+
+[deno]
+format = '\[[$symbol($version)]($style)\]'
+
+[docker_context]
+format = '\[[$symbol$context]($style)\]'
+
+[dotnet]
+format = '\[[$symbol($version)(🎯 $tfm)]($style)\]'
+
+[elixir]
+format = '\[[$symbol($version \(OTP $otp_version\))]($style)\]'
+
+[elm]
+format = '\[[$symbol($version)]($style)\]'
+
+[erlang]
+format = '\[[$symbol($version)]($style)\]'
+
+[git_branch]
+format = '\[[$symbol$branch]($style)\]'
+
+[git_status]
+format = '([\[$all_status$ahead_behind\]]($style))'
+
+[golang]
+format = '\[[$symbol($version)]($style)\]'
+
+[helm]
+format = '\[[$symbol($version)]($style)\]'
+
+[java]
+format = '\[[$symbol($version)]($style)\]'
+
+[julia]
+format = '\[[$symbol($version)]($style)\]'
+
+[kotlin]
+format = '\[[$symbol($version)]($style)\]'
+
+[lua]
+format = '\[[$symbol($version)]($style)\]'
+
+[memory_usage]
+format = '\[$symbol[$ram( | $swap)]($style)\]'
+
+[nim]
+format = '\[[$symbol($version)]($style)\]'
+
+[nix_shell]
+format = '\[[$symbol$state( \($name\))]($style)\]'
+
+[nodejs]
+format = '\[[$symbol($version)]($style)\]'
+
+[ocaml]
+format = '\[[$symbol($version)(\($switch_indicator$switch_name\))]($style)\]'
+
+[package]
+format = '\[[$symbol$version]($style)\]'
+
+[perl]
+format = '\[[$symbol($version)]($style)\]'
+
+[php]
+format = '\[[$symbol($version)]($style)\]'
+
+[purescript]
+format = '\[[$symbol($version)]($style)\]'
+
+[python]
+format = '\[[${symbol}${pyenv_prefix}(${version})(\($virtualenv\))]($style)\]'
+
+[red]
+format = '\[[$symbol($version)]($style)\]'
+
+[ruby]
+format = '\[[$symbol($version)]($style)\]'
+
+[rust]
+format = '\[[$symbol($version)]($style)\]'
+
+[scala]
+format = '\[[$symbol($version)]($style)\]'
+
+[swift]
+format = '\[[$symbol($version)]($style)\]'
+
+[terraform]
+format = '\[[$symbol$workspace]($style)\]'
+
+[vagrant]
+format = '\[[$symbol($version)]($style)\]'
+
+[zig]
+format = '\[[$symbol($version)]($style)\]'
+```