diff --git a/Cargo.toml b/Cargo.toml index 9f556cdd..4b39b510 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -8,7 +8,7 @@ documentation = "https://starship.rs/guide/" edition = "2021" homepage = "https://starship.rs" # Keep `/` in front of `README.md` to exclude localized readmes -include = ["src/**/*", "build.rs", "Cross.toml", "LICENSE", "README.md"] +include = ["src/**/*", "build.rs", "Cross.toml", "LICENSE", "/README.md", "docs/.vuepress/public/presets/toml/"] keywords = ["prompt", "shell", "bash", "fish", "zsh"] license = "ISC" readme = "README.md" diff --git a/docs/.vuepress/public/presets/bracketed-segments-after.png b/docs/.vuepress/public/presets/bracketed-segments-after.png deleted file mode 100644 index 24b4ea1a..00000000 Binary files a/docs/.vuepress/public/presets/bracketed-segments-after.png and /dev/null differ diff --git a/docs/.vuepress/public/presets/bracketed-segments-before.png b/docs/.vuepress/public/presets/bracketed-segments-before.png deleted file mode 100644 index e0fd1179..00000000 Binary files a/docs/.vuepress/public/presets/bracketed-segments-before.png and /dev/null differ diff --git a/docs/.vuepress/public/presets/hide-runtime-versions.png b/docs/.vuepress/public/presets/hide-runtime-versions.png deleted file mode 100644 index 4753d11e..00000000 Binary files a/docs/.vuepress/public/presets/hide-runtime-versions.png and /dev/null differ diff --git a/docs/.vuepress/public/presets/img/bracketed-segments.png b/docs/.vuepress/public/presets/img/bracketed-segments.png new file mode 100644 index 00000000..c1e6d0a4 Binary files /dev/null and b/docs/.vuepress/public/presets/img/bracketed-segments.png differ diff --git a/docs/.vuepress/public/presets/img/nerd-font-symbols.png b/docs/.vuepress/public/presets/img/nerd-font-symbols.png new file mode 100644 index 00000000..9e356437 Binary files /dev/null and b/docs/.vuepress/public/presets/img/nerd-font-symbols.png differ diff --git a/docs/.vuepress/public/presets/img/no-runtime-versions.png b/docs/.vuepress/public/presets/img/no-runtime-versions.png new file mode 100644 index 00000000..a985c8f3 Binary files /dev/null and b/docs/.vuepress/public/presets/img/no-runtime-versions.png differ diff --git a/docs/.vuepress/public/presets/img/plain-text-symbols.png b/docs/.vuepress/public/presets/img/plain-text-symbols.png new file mode 100644 index 00000000..66d681e4 Binary files /dev/null and b/docs/.vuepress/public/presets/img/plain-text-symbols.png differ diff --git a/docs/.vuepress/public/presets/img/pure-preset.png b/docs/.vuepress/public/presets/img/pure-preset.png new file mode 100644 index 00000000..3c6edd3c Binary files /dev/null and b/docs/.vuepress/public/presets/img/pure-preset.png differ diff --git a/docs/.vuepress/public/presets/nerd-font-symbols.png b/docs/.vuepress/public/presets/nerd-font-symbols.png deleted file mode 100644 index 524086ab..00000000 Binary files a/docs/.vuepress/public/presets/nerd-font-symbols.png and /dev/null differ diff --git a/docs/.vuepress/public/presets/plain-text-symbols-after.png b/docs/.vuepress/public/presets/plain-text-symbols-after.png deleted file mode 100644 index 81aa0e57..00000000 Binary files a/docs/.vuepress/public/presets/plain-text-symbols-after.png and /dev/null differ diff --git a/docs/.vuepress/public/presets/plain-text-symbols-before.png b/docs/.vuepress/public/presets/plain-text-symbols-before.png deleted file mode 100644 index 8ddbf7a6..00000000 Binary files a/docs/.vuepress/public/presets/plain-text-symbols-before.png and /dev/null differ diff --git a/docs/.vuepress/public/presets/pure-prompt.png b/docs/.vuepress/public/presets/pure-prompt.png deleted file mode 100644 index 6b078e37..00000000 Binary files a/docs/.vuepress/public/presets/pure-prompt.png and /dev/null differ diff --git a/docs/.vuepress/public/presets/toml/bracketed-segments.toml b/docs/.vuepress/public/presets/toml/bracketed-segments.toml new file mode 100644 index 00000000..726b3ddf --- /dev/null +++ b/docs/.vuepress/public/presets/toml/bracketed-segments.toml @@ -0,0 +1,143 @@ +[aws] +format = '\[[$symbol($profile)(\($region\))(\[$duration\])]($style)\]' + +[cmake] +format = '\[[$symbol($version)]($style)\]' + +[cmd_duration] +format = '\[[⏱ $duration]($style)\]' + +[cobol] +format = '\[[$symbol($version)]($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)\]' + +[gcloud] +format = '\[[$symbol$account(@$domain)(\($region\))]($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)\]' + +[hg_branch] +format = '\[[$symbol$branch]($style)\]' + +[java] +format = '\[[$symbol($version)]($style)\]' + +[julia] +format = '\[[$symbol($version)]($style)\]' + +[kotlin] +format = '\[[$symbol($version)]($style)\]' + +[kubernetes] +format = '\[[$symbol$context( \($namespace\))]($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)\]' + +[openstack] +format = '\[[$symbol$cloud(\($project\))]($style)\]' + +[package] +format = '\[[$symbol$version]($style)\]' + +[perl] +format = '\[[$symbol($version)]($style)\]' + +[php] +format = '\[[$symbol($version)]($style)\]' + +[pulumi] +format = '\[[$symbol$stack]($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)\]' + +[sudo] +format = '\[[as $symbol]\]' + +[swift] +format = '\[[$symbol($version)]($style)\]' + +[terraform] +format = '\[[$symbol$workspace]($style)\]' + +[time] +format = '\[[$time]($style)\]' + +[username] +format = '\[[$user]($style)\]' + +[vagrant] +format = '\[[$symbol($version)]($style)\]' + +[vlang] +format = '\[[$symbol($version)]($style)\]' + +[zig] +format = '\[[$symbol($version)]($style)\]' diff --git a/docs/.vuepress/public/presets/toml/nerd-font-symbols.toml b/docs/.vuepress/public/presets/toml/nerd-font-symbols.toml new file mode 100644 index 00000000..26c8da83 --- /dev/null +++ b/docs/.vuepress/public/presets/toml/nerd-font-symbols.toml @@ -0,0 +1,53 @@ +[aws] +symbol = " " + +[conda] +symbol = " " + +[dart] +symbol = " " + +[directory] +read_only = " " + +[docker_context] +symbol = " " + +[elixir] +symbol = " " + +[elm] +symbol = " " + +[git_branch] +symbol = " " + +[golang] +symbol = " " + +[hg_branch] +symbol = " " + +[java] +symbol = " " + +[julia] +symbol = " " + +[memory_usage] +symbol = " " + +[nim] +symbol = " " + +[nix_shell] +symbol = " " + +[nodejs] +symbol = " " + +[package] +symbol = " " + +[rust] +symbol = " " diff --git a/docs/.vuepress/public/presets/toml/no-runtime-versions.toml b/docs/.vuepress/public/presets/toml/no-runtime-versions.toml new file mode 100644 index 00000000..ca2d82d1 --- /dev/null +++ b/docs/.vuepress/public/presets/toml/no-runtime-versions.toml @@ -0,0 +1,89 @@ +[cmake] +format = "via [$symbol]($style)" + +[cobol] +format = "via [$symbol]($style)" + +[crystal] +format = "via [$symbol]($style)" + +[dart] +format = "via [$symbol]($style)" + +[deno] +format = "via [$symbol]($style)" + +[dotnet] +format = "[$symbol(🎯 $tfm )]($style)" + +[elixir] +format = 'via [$symbol]($style)' + +[elm] +format = 'via [$symbol]($style)' + +[erlang] +format = 'via [$symbol]($style)' + +[golang] +format = 'via [$symbol]($style)' + +[helm] +format = 'via [$symbol]($style)' + +[julia] +format = 'via [$symbol]($style)' + +[kotlin] +format = 'via [$symbol]($style)' + +[lua] +format = 'via [$symbol]($style)' + +[nim] +format = 'via [$symbol]($style)' + +[nodejs] +format = 'via [$symbol]($style)' + +[ocaml] +format = 'via [$symbol(\($switch_indicator$switch_name\) )]($style)' + +[perl] +format = 'via [$symbol]($style)' + +[php] +format = 'via [$symbol]($style)' + +[pulumi] +format = 'via [$symbol$stack]($style)' + +[purescript] +format = 'via [$symbol]($style)' + +[python] +format = 'via [$symbol]($style)' + +[red] +format = 'via [$symbol]($style)' + +[rlang] +format = 'via [$symbol]($style)' + +[ruby] +format = 'via [$symbol]($style)' + +[rust] +format = 'via [$symbol]($style)' + +[swift] +format = 'via [$symbol]($style)' + +[vagrant] +format = 'via [$symbol]($style)' + +[vlang] +format = 'via [$symbol]($style)' + +[zig] +format = 'via [$symbol]($style)' diff --git a/docs/.vuepress/public/presets/toml/plain-text-symbols.toml b/docs/.vuepress/public/presets/toml/plain-text-symbols.toml new file mode 100644 index 00000000..f8687356 --- /dev/null +++ b/docs/.vuepress/public/presets/toml/plain-text-symbols.toml @@ -0,0 +1,116 @@ +[character] +success_symbol = "[>](bold green)" +error_symbol = "[x](bold red)" +vicmd_symbol = "[<](bold green)" + +[git_commit] +tag_symbol = " tag " + +[git_status] +ahead = ">" +behind = "<" +diverged = "<>" +renamed = "r" +deleted = "x" + +[aws] +symbol = "aws " + +[cobol] +symbol = "cobol " + +[conda] +symbol = "conda " + +[crystal] +symbol = "cr " + +[cmake] +symbol = "cmake " + +[dart] +symbol = "dart " + +[deno] +symbol = "deno " + +[dotnet] +symbol = ".NET " + +[directory] +read_only = " ro" + +[docker_context] +symbol = "docker " + +[elixir] +symbol = "exs " + +[elm] +symbol = "elm " + +[git_branch] +symbol = "git " + +[golang] +symbol = "go " + +[hg_branch] +symbol = "hg " + +[java] +symbol = "java " + +[julia] +symbol = "jl " + +[kotlin] +symbol = "kt " + +[nodejs] +symbol = "nodejs " + +[memory_usage] +symbol = "memory " + +[nim] +symbol = "nim " + +[nix_shell] +symbol = "nix " + +[ocaml] +symbol = "ml " + +[package] +symbol = "pkg " + +[perl] +symbol = "pl " + +[php] +symbol = "php " + +[pulumi] +symbol = "pulumi " + +[purescript] +symbol = "purs " + +[python] +symbol = "py " + +[ruby] +symbol = "rb " + +[rust] +symbol = "rs " + +[scala] +symbol = "scala " + +[sudo] +symbol = "sudo " + +[swift] +symbol = "swift " diff --git a/docs/.vuepress/public/presets/toml/pure-preset.toml b/docs/.vuepress/public/presets/toml/pure-preset.toml new file mode 100644 index 00000000..377378ee --- /dev/null +++ b/docs/.vuepress/public/presets/toml/pure-preset.toml @@ -0,0 +1,46 @@ +format = """ +$username\ +$hostname\ +$directory\ +$git_branch\ +$git_state\ +$git_status\ +$cmd_duration\ +$line_break\ +$python\ +$character""" + +[directory] +style = "blue" + +[character] +success_symbol = "[❯](purple)" +error_symbol = "[❯](red)" +vicmd_symbol = "[❮](green)" + +[git_branch] +format = "[$branch]($style)" +style = "bright-black" + +[git_status] +format = "[[(*$conflicted$untracked$modified$staged$renamed$deleted)](218) ($ahead_behind$stashed)]($style)" +style = "cyan" +conflicted = "​" +untracked = "​" +modified = "​" +staged = "​" +renamed = "​" +deleted = "​" +stashed = "≡" + +[git_state] +format = '\([$state( $progress_current/$progress_total)]($style)\) ' +style = "bright-black" + +[cmd_duration] +format = "[$duration]($style) " +style = "yellow" + +[python] +format = "[$virtualenv]($style) " +style = "bright-black" diff --git a/docs/presets/README.md b/docs/presets/README.md index 50153570..afa7a7bf 100644 --- a/docs/presets/README.md +++ b/docs/presets/README.md @@ -3,541 +3,36 @@ Here is a collection of community-submitted configuration presets for Starship. If you have a preset to share, please [submit a PR](https://github.com/starship/starship/edit/master/docs/presets/README.md) updating this file! 😊 -## Nerd Font Symbols +To get details on how to use a preset, simply click on the image. -This preset doesn't change anything except for the symbols used for each module. -If emojis aren't your thing, this might catch your eye! +## [Nerd Font Symbols](./nerd-font) -![Screenshot of Nerd Font Symbols preset](/presets/nerd-font-symbols.png) +This preset changes the symbols for each module to use Nerd Font symbols. -### Prerequisites +[![Screenshot of Nerd Font Symbols preset](/presets/img/nerd-font-symbols.png "Click to view Nerd Font Symbols preset")](./nerd-font) -- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Fira Code Nerd Font) - -### Configuration - -```toml -[aws] -symbol = " " - -[conda] -symbol = " " - -[dart] -symbol = " " - -[directory] -read_only = " " - -[docker_context] -symbol = " " - -[elixir] -symbol = " " - -[elm] -symbol = " " - -[git_branch] -symbol = " " - -[golang] -symbol = " " - -[hg_branch] -symbol = " " - -[java] -symbol = " " - -[julia] -symbol = " " - -[memory_usage] -symbol = " " - -[nim] -symbol = " " - -[nix_shell] -symbol = " " - -[nodejs] -symbol = " " - -[package] -symbol = " " - -[perl] -symbol = " " - -[php] -symbol = " " - -[python] -symbol = " " - -[ruby] -symbol = " " - -[rust] -symbol = " " - -[scala] -symbol = " " - -[shlvl] -symbol = " " - -[swift] -symbol = "ﯣ " -``` - -## Bracketed Segments +## [Bracketed Segments](./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 Bracketed Segments preset](/presets/img/bracketed-segments.png "Click to view Bracketed Segments preset")](./bracketed-segments) -![Screenshot of default Starship configuration](/presets/bracketed-segments-before.png) +## [Plain Text Symbols](./plain-text) -After: +This preset changes the symbols for each module into plain text. Great if you +don't have access to Unicode. -![Screenshot of Bracketed Segments preset](/presets/bracketed-segments-after.png) +[![Screenshot of Plain Text Symbols preset](/presets/img/plain-text-symbols.png "Click to view Plain Text Symbols preset")](./plain-text) -### Configuration - -```toml -[aws] -format = '\[[$symbol($profile)(\($region\))(\[$duration\])]($style)\]' - -[cmake] -format = '\[[$symbol($version)]($style)\]' - -[cmd_duration] -format = '\[[⏱ $duration]($style)\]' - -[cobol] -format = '\[[$symbol($version)]($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)\]' - -[gcloud] -format = '\[[$symbol$account(@$domain)(\($region\))]($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)\]' - -[hg_branch] -format = '\[[$symbol$branch]($style)\]' - -[java] -format = '\[[$symbol($version)]($style)\]' - -[julia] -format = '\[[$symbol($version)]($style)\]' - -[kotlin] -format = '\[[$symbol($version)]($style)\]' - -[kubernetes] -format = '\[[$symbol$context( \($namespace\))]($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)\]' - -[openstack] -format = '\[[$symbol$cloud(\($project\))]($style)\]' - -[package] -format = '\[[$symbol$version]($style)\]' - -[perl] -format = '\[[$symbol($version)]($style)\]' - -[php] -format = '\[[$symbol($version)]($style)\]' - -[pulumi] -format = '\[[$symbol$stack]($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)\]' - -[sudo] -format = '\[[as $symbol]\]' - -[swift] -format = '\[[$symbol($version)]($style)\]' - -[terraform] -format = '\[[$symbol$workspace]($style)\]' - -[time] -format = '\[[$time]($style)\]' - -[username] -format = '\[[$user]($style)\]' - -[vagrant] -format = '\[[$symbol($version)]($style)\]' - -[vlang] -format = '\[[$symbol($version)]($style)\]' - -[zig] -format = '\[[$symbol($version)]($style)\]' -``` - -## Plain Text Symbols - -This preset changes the symbols into plain text. -If your terminal/font could not render the NerdFonts/emojis, maybe you could try this preset! - -Before (default setting with Fixedsys font): - -![Screenshot of default Starship configuration with Fixedsys font](/presets/plain-text-symbols-before.png) - -After (Plain Text Symbols): - -![Screenshot of Plain Text Symbols preset](/presets/plain-text-symbols-after.png) - -### Configuration - -```toml -[character] -success_symbol = "[>](bold green)" -error_symbol = "[x](bold red)" -vicmd_symbol = "[<](bold green)" - -[git_commit] -tag_symbol = " tag " - -[git_status] -ahead = ">" -behind = "<" -diverged = "<>" -renamed = "r" -deleted = "x" - -[aws] -symbol = "aws " - -[cobol] -symbol = "cobol " - -[conda] -symbol = "conda " - -[crystal] -symbol = "cr " - -[cmake] -symbol = "cmake " - -[dart] -symbol = "dart " - -[deno] -symbol = "deno " - -[dotnet] -symbol = ".NET " - -[directory] -read_only = " ro" - -[docker_context] -symbol = "docker " - -[elixir] -symbol = "exs " - -[elm] -symbol = "elm " - -[git_branch] -symbol = "git " - -[golang] -symbol = "go " - -[hg_branch] -symbol = "hg " - -[java] -symbol = "java " - -[julia] -symbol = "jl " - -[kotlin] -symbol = "kt " - -[nodejs] -symbol = "nodejs " - -[memory_usage] -symbol = "memory " - -[nim] -symbol = "nim " - -[nix_shell] -symbol = "nix " - -[ocaml] -symbol = "ml " - -[package] -symbol = "pkg " - -[perl] -symbol = "pl " - -[php] -symbol = "php " - -[pulumi] -symbol = "pulumi " - -[purescript] -symbol = "purs " - -[python] -symbol = "py " - -[ruby] -symbol = "rb " - -[rust] -symbol = "rs " - -[scala] -symbol = "scala " - -[sudo] -symbol = "sudo " - -[swift] -symbol = "swift " -``` - -## Hide Runtime Versions +## [No Runtime Versions](./no-runtimes) This preset hides the version of language runtimes. If you work in containers or virtualized environments, this one is for you! -![Screenshot of Hide Runtime Versions preset](/presets/hide-runtime-versions.png) +[![Screenshot of Hide Runtime Versions preset](/presets/img/no-runtime-versions.png "Click to view No Runtime Versions preset")](./no-runtimes) -### Configuration - -```toml -[cmake] -format = "via [$symbol]($style)" - -[cobol] -format = "via [$symbol]($style)" - -[crystal] -format = "via [$symbol]($style)" - -[dart] -format = "via [$symbol]($style)" - -[deno] -format = "via [$symbol]($style)" - -[dotnet] -format = "[$symbol(🎯 $tfm )]($style)" - -[elixir] -format = 'via [$symbol]($style)' - -[elm] -format = 'via [$symbol]($style)' - -[erlang] -format = 'via [$symbol]($style)' - -[golang] -format = 'via [$symbol]($style)' - -[helm] -format = 'via [$symbol]($style)' - -[julia] -format = 'via [$symbol]($style)' - -[kotlin] -format = 'via [$symbol]($style)' - -[lua] -format = 'via [$symbol]($style)' - -[nim] -format = 'via [$symbol]($style)' - -[nodejs] -format = 'via [$symbol]($style)' - -[ocaml] -format = 'via [$symbol(\($switch_indicator$switch_name\) )]($style)' - -[perl] -format = 'via [$symbol]($style)' - -[php] -format = 'via [$symbol]($style)' - -[pulumi] -format = 'via [$symbol$stack]($style)' - -[purescript] -format = 'via [$symbol]($style)' - -[red] -format = 'via [$symbol]($style)' - -[rlang] -format = 'via [$symbol]($style)' - -[ruby] -format = 'via [$symbol]($style)' - -[rust] -format = 'via [$symbol]($style)' - -[swift] -format = 'via [$symbol]($style)' - -[vagrant] -format = 'via [$symbol]($style)' - -[vlang] -format = 'via [$symbol]($style)' - -[zig] -format = 'via [$symbol]($style)' -``` - -## Pure +## [Pure Prompt](./pure-preset) This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure). -![Screenshot of Pure preset](/presets/pure-prompt.png) - -### Configuration - -```toml -format = """ -$username\ -$hostname\ -$directory\ -$git_branch\ -$git_state\ -$git_status\ -$cmd_duration\ -$line_break\ -$python\ -$character""" - -[directory] -style = "blue" - -[character] -success_symbol = "[❯](purple)" -error_symbol = "[❯](red)" -vicmd_symbol = "[❮](green)" - -[git_branch] -format = "[$branch]($style)" -style = "bright-black" - -[git_status] -format = "[[(*$conflicted$untracked$modified$staged$renamed$deleted)](218) ($ahead_behind$stashed)]($style)" -style = "cyan" -conflicted = "​" -untracked = "​" -modified = "​" -staged = "​" -renamed = "​" -deleted = "​" -stashed = "≡" - -[git_state] -format = '\([$state( $progress_current/$progress_total)]($style)\) ' -style = "bright-black" - -[cmd_duration] -format = "[$duration]($style) " -style = "yellow" - -[python] -format = "[$virtualenv]($style) " -style = "bright-black" -``` +[![Screenshot of Pure preset](/presets/img/pure-preset.png "Click to view Pure Prompt preset")](./pure-preset) diff --git a/docs/presets/bracketed-segments.md b/docs/presets/bracketed-segments.md new file mode 100644 index 00000000..6402020e --- /dev/null +++ b/docs/presets/bracketed-segments.md @@ -0,0 +1,14 @@ +[Return to Presets](/presets/#bracketed-segments) + +# Bracketed Segments Preset + +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.). + +![Screenshot of Bracketed Segments preset](/presets/img/bracketed-segments.png) + +### Configuration + +[Click to download TOML](/presets/toml/bracketed-segments.toml) + +<<< @/.vuepress/public/presets/toml/bracketed-segments.toml diff --git a/docs/presets/nerd-font.md b/docs/presets/nerd-font.md new file mode 100644 index 00000000..82cedb19 --- /dev/null +++ b/docs/presets/nerd-font.md @@ -0,0 +1,17 @@ +[Return to Presets](/presets/#nerd-font-symbols) + +# Nerd Font Symbols Preset + +This preset changes the symbols for each module to use Nerd Font symbols. + +![Screenshot of Nerd Font Symbols preset](/presets/img/nerd-font-symbols.png) + +### Prerequisites + +- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Fira Code Nerd Font) + +### Configuration + +[Click to download TOML](/presets/toml/nerd-font-symbols.toml) + +<<< @/.vuepress/public/presets/toml/nerd-font-symbols.toml diff --git a/docs/presets/no-runtimes.md b/docs/presets/no-runtimes.md new file mode 100644 index 00000000..1815872d --- /dev/null +++ b/docs/presets/no-runtimes.md @@ -0,0 +1,13 @@ +[Return to Presets](/presets/#no-runtime-versions) + +# No Runtime Versions Preset + +This preset hides the version of language runtimes. If you work in containers or virtualized environments, this one is for you! + +![Screenshot of Hide Runtime Versions preset](/presets/img/no-runtime-versions.png) + +### Configuration + +[Click to download TOML](/presets/toml/no-runtime-versions.toml) + +<<< @/.vuepress/public/presets/toml/no-runtime-versions.toml diff --git a/docs/presets/plain-text.md b/docs/presets/plain-text.md new file mode 100644 index 00000000..e80c85d2 --- /dev/null +++ b/docs/presets/plain-text.md @@ -0,0 +1,14 @@ +[Return to Presets](/presets/#plain-text-symbols) + +## Plain Text Symbols Preset + +This preset changes the symbols for each module into plain text. Great if you +don't have access to Unicode. + +![Screenshot of Plain Text Symbols preset](/presets/img/plain-text-symbols.png) + +### Configuration + +[Click to download TOML](/presets/toml/plain-text-symbols.toml) + +<<< @/.vuepress/public/presets/toml/plain-text-symbols.toml diff --git a/docs/presets/pure-preset.md b/docs/presets/pure-preset.md new file mode 100644 index 00000000..96a1b6a2 --- /dev/null +++ b/docs/presets/pure-preset.md @@ -0,0 +1,13 @@ +[Return to Presets](/presets/#pure) + +# Pure Preset + +This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure). + +![Screenshot of Pure preset](/presets/img/pure-preset.png) + +### Configuration + +[Click to download TOML](/presets/toml/pure-preset.toml) + +<<< @/.vuepress/public/presets/toml/pure-preset.toml