mirror of
https://github.com/starship/starship.git
synced 2026-06-22 02:02:12 +07:00
feat(docs): move to vitepress (#5785)
* feat(docs): move to vitepress * change up hero styles to match existing site * A bit more style tweaking * Replace stylus with plain CSS * improve unicode-range value for nerdfont --------- Co-authored-by: Matan Kushner <hello@matchai.dev>
This commit is contained in:
David Knaack
+12
-9
@@ -1,18 +1,21 @@
|
||||
---
|
||||
home: true
|
||||
heroImage: /logo.svg
|
||||
heroText:
|
||||
tagline: The minimal, blazing-fast, and infinitely customizable prompt for any shell!
|
||||
actionText: Get Started →
|
||||
actionLink: ./guide/
|
||||
layout: home
|
||||
hero:
|
||||
image: /logo.svg
|
||||
text: null
|
||||
tagline: The minimal, blazing-fast, and infinitely customizable prompt for any shell!
|
||||
actions:
|
||||
- theme: brand
|
||||
text: Get Started →
|
||||
link: ./guide/
|
||||
features:
|
||||
-
|
||||
-
|
||||
title: Compatibility First
|
||||
details: Works on the most common shells on the most common operating systems. Use it everywhere!
|
||||
-
|
||||
-
|
||||
title: Rust-Powered
|
||||
details: Brings the best-in-class speed and safety of Rust, to make your prompt as quick and reliable as possible.
|
||||
-
|
||||
-
|
||||
title: Customizable
|
||||
details: Every little detail is customizable to your liking, to make this prompt as minimal or feature-rich as you'd like it to be.
|
||||
footer: ISC Licensed | Copyright © 2019-present Starship Contributors
|
||||
|
||||
@@ -223,7 +223,7 @@ Invoke-Expression (&starship init powershell)
|
||||
|
||||
Some shells support a right prompt which renders on the same line as the input. Starship can set the content of the right prompt using the `right_format` option. Any module that can be used in `format` is also supported in `right_format`. The `$all` variable will only contain modules not explicitly used in either `format` or `right_format`.
|
||||
|
||||
Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill).
|
||||
Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](../config/#fill).
|
||||
|
||||
`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell, bash.
|
||||
|
||||
|
||||
@@ -158,7 +158,7 @@ For example:
|
||||
|
||||
#### Style Strings
|
||||
|
||||
Most modules in starship allow you to configure their display styles. This is done with an entry (usually called `style`) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the [advanced config guide](/advanced-config/).
|
||||
Most modules in starship allow you to configure their display styles. This is done with an entry (usually called `style`) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the [advanced config guide](../advanced-config/).
|
||||
|
||||
- `'fg:green bg:blue'` sets green text on a blue background
|
||||
- `'bg:blue fg:bright-green'` sets bright green text on a blue background
|
||||
@@ -200,12 +200,12 @@ This is the list of prompt-wide configuration options.
|
||||
| Option | Default | Description |
|
||||
| ----------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `format` | [link](#default-prompt-format) | Configure the format of the prompt. |
|
||||
| `right_format` | `''` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
|
||||
| `right_format` | `''` | See [Enable Right Prompt](../advanced-config/#enable-right-prompt) |
|
||||
| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
|
||||
| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). |
|
||||
| `add_newline` | `true` | Inserts blank line between shell prompts. |
|
||||
| `palette` | `''` | Sets which color palette from `palettes` to use. |
|
||||
| `palettes` | `{}` | Collection of color palettes that assign [colors](/advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. |
|
||||
| `palettes` | `{}` | Collection of color palettes that assign [colors](../advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. |
|
||||
| `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. |
|
||||
|
||||
::: tip
|
||||
|
||||
@@ -58,7 +58,7 @@ curl -sS https://starship.rs/install.sh | sh -s -- --platform unknown-linux-musl
|
||||
|
||||
## Why do I see `Executing command "..." timed out.` warnings?
|
||||
|
||||
Starship executes different commands to get information to display in the prompt, for example the version of a program or the current git status. To make sure starship doesn't hang while trying to execute these commands we set a time limit, if a command takes longer than this limit starship will stop the execution of the command and output the above warning, this is expected behaviour. This time limit is configurable using the [`command_timeout`key](/config/#prompt) so if you want you can increase the time limit. You can also follow the debugging steps below to see which command is being slow and see if you can optimise it. Finally you can set the `STARSHIP_LOG` env var to `error` to hide these warnings.
|
||||
Starship executes different commands to get information to display in the prompt, for example the version of a program or the current git status. To make sure starship doesn't hang while trying to execute these commands we set a time limit, if a command takes longer than this limit starship will stop the execution of the command and output the above warning, this is expected behaviour. This time limit is configurable using the [`command_timeout`key](../config/#prompt) so if you want you can increase the time limit. You can also follow the debugging steps below to see which command is being slow and see if you can optimise it. Finally you can set the `STARSHIP_LOG` env var to `error` to hide these warnings.
|
||||
|
||||
## I see symbols I don't understand or expect, what do they mean?
|
||||
|
||||
|
||||
@@ -40,11 +40,11 @@
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://starship.rs">Website</a>
|
||||
<a href="https://starship.rs/pt-PT">Website</a>
|
||||
·
|
||||
<a href="#🚀-installation">Installation</a>
|
||||
·
|
||||
<a href="https://starship.rs/config/">Configuration</a>
|
||||
<a href="https://starship.rs/pt-PT/config/">Configuration</a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
@@ -171,7 +171,7 @@
|
||||
- **Easy:** quick to install – start using it in minutes.
|
||||
|
||||
<p align="center">
|
||||
<a href="https://starship.rs/config/"><strong>Explore the Starship docs ▶</strong></a>
|
||||
<a href="https://starship.rs/pt-PT/config/"><strong>Explore the Starship docs ▶</strong></a>
|
||||
</p>
|
||||
|
||||
<a name="🚀-installation"></a>
|
||||
|
||||
@@ -5,7 +5,7 @@ To install starship, you need to do two things:
|
||||
1. Get the **starship** binary onto your computer
|
||||
1. Tell your shell to use the starship binary as its prompt by modifying its init scripts
|
||||
|
||||
For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed.
|
||||
For most users, the instructions on [the main page](../guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed.
|
||||
|
||||
There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out!
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./README.md#bracketed-segments)
|
||||
[Return to Presets](./#bracketed-segments)
|
||||
|
||||
# Bracketed Segments Preset
|
||||
|
||||
@@ -14,4 +14,4 @@ starship preset bracketed-segments -o ~/.config/starship.toml
|
||||
|
||||
[Click to download TOML](/presets/toml/bracketed-segments.toml)
|
||||
|
||||
<<< @/.vuepress/public/presets/toml/bracketed-segments.toml
|
||||
<<< @/public/presets/toml/bracketed-segments.toml
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./README.md#gruvbox-rainbow)
|
||||
[Return to Presets](./#gruvbox-rainbow)
|
||||
|
||||
# Gruvbox Rainbow Preset
|
||||
|
||||
@@ -18,4 +18,4 @@ starship preset gruvbox-rainbow -o ~/.config/starship.toml
|
||||
|
||||
[Click to download TOML](/presets/toml/gruvbox-rainbow.toml)
|
||||
|
||||
<<< @/.vuepress/public/presets/toml/gruvbox-rainbow.toml
|
||||
<<< @/public/presets/toml/gruvbox-rainbow.toml
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./README.md#jetpack)
|
||||
[Return to Presets](./#jetpack)
|
||||
|
||||
# Jetpack Preset
|
||||
|
||||
@@ -21,4 +21,4 @@ starship preset jetpack -o ~/.config/starship.toml
|
||||
|
||||
[Click to download TOML](/presets/toml/jetpack.toml)
|
||||
|
||||
<<< @/.vuepress/public/presets/toml/jetpack.toml
|
||||
<<< @/public/presets/toml/jetpack.toml
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./README.md#nerd-font-symbols)
|
||||
[Return to Presets](./#nerd-font-symbols)
|
||||
|
||||
# Nerd Font Symbols Preset
|
||||
|
||||
@@ -18,4 +18,4 @@ starship preset nerd-font-symbols -o ~/.config/starship.toml
|
||||
|
||||
[Click to download TOML](/presets/toml/nerd-font-symbols.toml)
|
||||
|
||||
<<< @/.vuepress/public/presets/toml/nerd-font-symbols.toml
|
||||
<<< @/public/presets/toml/nerd-font-symbols.toml
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./README.md#no-empty-icons)
|
||||
[Return to Presets](./#no-empty-icons)
|
||||
|
||||
# No Empty Icons Preset
|
||||
|
||||
@@ -14,4 +14,4 @@ starship preset no-empty-icons -o ~/.config/starship.toml
|
||||
|
||||
[Click to download TOML](/presets/toml/no-empty-icons.toml)
|
||||
|
||||
<<< @/.vuepress/public/presets/toml/no-empty-icons.toml
|
||||
<<< @/public/presets/toml/no-empty-icons.toml
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./README.md#no-nerd-fonts)
|
||||
[Return to Presets](./#no-nerd-fonts)
|
||||
|
||||
# No Nerd Fonts Preset
|
||||
|
||||
@@ -16,4 +16,4 @@ starship preset no-nerd-font -o ~/.config/starship.toml
|
||||
|
||||
[Click to download TOML](/presets/toml/no-nerd-font.toml)
|
||||
|
||||
<<< @/.vuepress/public/presets/toml/no-nerd-font.toml
|
||||
<<< @/public/presets/toml/no-nerd-font.toml
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./README.md#no-runtime-versions)
|
||||
[Return to Presets](./#no-runtime-versions)
|
||||
|
||||
# No Runtime Versions Preset
|
||||
|
||||
@@ -14,4 +14,4 @@ starship preset no-runtime-versions -o ~/.config/starship.toml
|
||||
|
||||
[Click to download TOML](/presets/toml/no-runtime-versions.toml)
|
||||
|
||||
<<< @/.vuepress/public/presets/toml/no-runtime-versions.toml
|
||||
<<< @/public/presets/toml/no-runtime-versions.toml
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./README.md#pastel-powerline)
|
||||
[Return to Presets](./#pastel-powerline)
|
||||
|
||||
# Pastel Powerline Preset
|
||||
|
||||
@@ -18,4 +18,4 @@ starship preset pastel-powerline -o ~/.config/starship.toml
|
||||
|
||||
[Click to download TOML](/presets/toml/pastel-powerline.toml)
|
||||
|
||||
<<< @/.vuepress/public/presets/toml/pastel-powerline.toml
|
||||
<<< @/public/presets/toml/pastel-powerline.toml
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./README.md#plain-text-symbols)
|
||||
[Return to Presets](./#plain-text-symbols)
|
||||
|
||||
## Plain Text Symbols Preset
|
||||
|
||||
@@ -14,4 +14,4 @@ starship preset plain-text-symbols -o ~/.config/starship.toml
|
||||
|
||||
[Click to download TOML](/presets/toml/plain-text-symbols.toml)
|
||||
|
||||
<<< @/.vuepress/public/presets/toml/plain-text-symbols.toml
|
||||
<<< @/public/presets/toml/plain-text-symbols.toml
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./README.md#pure)
|
||||
[Return to Presets](./#pure)
|
||||
|
||||
# Pure Preset
|
||||
|
||||
@@ -14,4 +14,4 @@ starship preset pure-preset -o ~/.config/starship.toml
|
||||
|
||||
[Click to download TOML](/presets/toml/pure-preset.toml)
|
||||
|
||||
<<< @/.vuepress/public/presets/toml/pure-preset.toml
|
||||
<<< @/public/presets/toml/pure-preset.toml
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[Return to Presets](./README.md#pastel-powerline)
|
||||
[Return to Presets](./#pastel-powerline)
|
||||
|
||||
# Tokyo Night Preset
|
||||
|
||||
@@ -18,4 +18,4 @@ starship preset tokyo-night -o ~/.config/starship.toml
|
||||
|
||||
[Click to download TOML](/presets/toml/tokyo-night.toml)
|
||||
|
||||
<<< @/.vuepress/public/presets/toml/tokyo-night.toml
|
||||
<<< @/public/presets/toml/tokyo-night.toml
|
||||
|
||||
Reference in New Issue
Block a user