Llewellyn/starship
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/starship.git synced 2025-02-03 20:48:30 +00:00
Code Issues Releases Activity
starship/docs
History
Kesavan Yogeswaran 70dcd33aa2
docs(conda): Fix default format in Conda module's config doc (#1965) 
* docs: Fix default format string for Conda module

 #### Issues Addressed

 The default `format` string for the Conda module starts with "via", as
 seen [here](2e763b5e7c/src/configs/conda.rs (L19)).
 However, this is not reflected in the config docs.

 Many similar modules include "via" in their default format string so I
 assume including it is the intended behavior, and that the doc should
 be updated.

 #### Summary of Changes

 Correct the default `format` string for the Conda module in the config
 docs.

* Revert changes to i18n files

Revert changes to i18n files, as these must be handled by Crowdin
2020-12-06 21:02:15 +01:00
..
.vuepress
docs(i18n): add French and Spanish doc translations (#1942)
2020-11-29 14:33:38 -05:00
advanced-config
fix: bg:none overwrites foreground colour (#1903)
2020-12-02 00:40:15 -06:00
config
docs(conda): Fix default format in Conda module's config doc (#1965)
2020-12-06 21:02:15 +01:00
de-DE
docs(i18n): New Crowdin updates (#1788)
2020-11-28 23:45:59 -05:00
es-ES
docs(i18n): New Crowdin updates (#1788)
2020-11-28 23:45:59 -05:00
faq
docs(FAQ): add FAQ about shell completions
2020-10-05 14:26:22 -04:00
fr-FR
docs(i18n): New Crowdin updates (#1788)
2020-11-28 23:45:59 -05:00
guide
docs: Add vuepress with initial docs (#99)
2019-07-19 16:18:52 -04:00
ja-JP
docs(i18n): New Crowdin updates (#1788)
2020-11-28 23:45:59 -05:00
migrating-to-0.45.0
docs: Update defaults in config docs (#1759)
2020-10-12 00:10:39 -04:00
presets
docs: update rust icon in preset configuration (#1900)
2020-11-17 20:32:48 +01:00
pt-BR
docs(i18n): New Crowdin updates (#1788)
2020-11-28 23:45:59 -05:00
pt-PT
docs(i18n): New Crowdin updates (#1788)
2020-11-28 23:45:59 -05:00
ru-RU
docs(i18n): New Crowdin updates (#1788)
2020-11-28 23:45:59 -05:00
zh-CN
docs(i18n): New Crowdin updates (#1788)
2020-11-28 23:45:59 -05:00
zh-TW
docs(i18n): New Crowdin updates (#1788)
2020-11-28 23:45:59 -05:00
package-lock.json
build(deps-dev): bump @vuepress/plugin-google-analytics in /docs (#1808)
2020-10-19 15:55:22 +00:00
package.json
build(deps-dev): bump @vuepress/plugin-google-analytics in /docs (#1808)
2020-10-19 15:55:22 +00:00
README.md
docs(pwsh/init): various fixes for init doc (#1793)
2020-11-03 18:52:46 +01:00

README.md

home heroImage heroText tagline actionText actionLink features footer metaTitle description
true /logo.svg null The minimal, blazing-fast, and infinitely customizable prompt for any shell! Get Started → ./guide/
title details
Compatibility First Works on the most common shells on the most common operating systems. Use it everywhere!
title details
Rust-Powered Brings the best-in-class speed and safety of Rust, to make your prompt as quick and reliable as possible.
title details
Customizable Every little detail is customizable to your liking, to make this prompt as minimal or feature-rich as you'd like it to be.
ISC Licensed | Copyright © 2019-present Starship Contributors Starship: Cross-Shell Prompt Starship is the minimal, blazing fast, and extremely customizable prompt for any shell! Shows the information you need, while staying sleek and minimal. Quick installation available for Bash, Fish, ZSH, Ion, and PowerShell.

Quick Install

  1. Install the starship binary:

    Install Latest Version

    With Shell:

    curl -fsSL https://starship.rs/install.sh | bash

    Install via Package Manager

    With Homebrew:

    brew install starship

    With Scoop:

    scoop install starship

  2. Add the init script to your shell's config file:

    Bash

    Add the following to the end of ~/.bashrc:

    # ~/.bashrc

eval "$(starship init bash)"

    Fish

    Add the following to the end of ~/.config/fish/config.fish:

    # ~/.config/fish/config.fish

starship init fish | source

    Zsh

    Add the following to the end of ~/.zshrc:

    # ~/.zshrc

eval "$(starship init zsh)"

    Powershell

    Add the following to the end of Microsoft.PowerShell_profile.ps1. You can check the location of this file by querying the $PROFILE variable in PowerShell. Typically the path is ~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1 or ~/.config/powershell/Microsoft.PowerShell_profile.ps1 on -Nix.

    Invoke-Expression (&starship init powershell)

    Ion

    Add the following to the end of ~/.config/ion/initrc:

    # ~/.config/ion/initrc

eval $(starship init ion)