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>
2026-06-23 02:05:51 +07:00 · 2024-03-03 17:55:30 +01:00
parent 421b358c32
commit 7485c90c9f
424 changed files with 2893 additions and 27713 deletions
@@ -1,18 +1,21 @@
 ---
-home: true
-heroImage: /logo.svg
-heroText:
-tagline: O prompt minimalista, extremamente rápido e infinitamente personalizável para qualquer shell!
-actionText: Primeiros passos →
-actionLink: ./guide/
+layout: home
+hero:
+  image: /logo.svg
+  text: null
+  tagline: O prompt minimalista, extremamente rápido e infinitamente personalizável para qualquer shell!
+  actions:
+    - theme: brand
+      text: Primeiros passos →
+      link: ./guide/
 features:
-  - 
+  -
    title: Compatibilidade primeiro
    details: Funciona nos principais shells nos principais sistemas operacionais. Use em qualquer lugar!
-  - 
+  -
    title: Poder do Rust
    details: Tenha o melhor da velocidade e segurança do Rust, para tornar seu prompt o mais rápido e confiável possível.
-  - 
+  -
    title: Personalizável
    details: Cada pequeno detalhe é personalizável ao seu gosto, para tornar esse prompt o mínimo possível ou rico em recursos, como você preferir.
 footer: Licenciado pelo ISC | Todos os direitos reservados © 2019-Presente | Contribuidores Starship
@@ -223,7 +223,7 @@ Invoke-Expression (&starship init powershell)

 Alguns shells suportam um prompt direito que é renderizado na mesma linha que a entrada. Starship pode definir o conteúdo do prompt correto usando a opção `right_format`. Qualquer módulo que pode ser usado no `format` também é compatível com `right_format`. A variável `$all` conterá apenas módulos não usado explicitamente em `format` ou `right_format`.

-Nota: O prompt direito é uma única linha após o local de entrada. Para alinhar módulos à direita acima da linha de entrada em um prompt de várias linhas, consulte o [módulo `fill`](/config/#fill).
+Nota: O prompt direito é uma única linha após o local de entrada. Para alinhar módulos à direita acima da linha de entrada em um prompt de várias linhas, consulte o [módulo `fill`](../config/#fill).

 `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell, bash.

@@ -106,7 +106,7 @@ format = '''

 \$'''

-# com string básica multilinha 
+# com string básica multilinha
 format = """

 \\$"""
@@ -158,7 +158,7 @@ Por exemplo:

 #### Estilo dos textos

-A maioria dos módulos no starship permite que você configure seus estilos de exibição. Isso é feito com uma entrada (normalmente chamada de `estilo`) que é uma string especificando a configuração. Aqui estão alguns exemplos de strings de estilo junto com o que elas fazem. Para obter detalhes sobre a sintaxe completa, consulte o [guia de configuração avançada](/advanced-config/).
+A maioria dos módulos no starship permite que você configure seus estilos de exibição. Isso é feito com uma entrada (normalmente chamada de `estilo`) que é uma string especificando a configuração. Aqui estão alguns exemplos de strings de estilo junto com o que elas fazem. Para obter detalhes sobre a sintaxe completa, consulte o [guia de configuração avançada](../advanced-config/).

 - `"fg:green bg:blue"` define o texto para verde e o fundo azul
 - `"bg:blue fg:bright-green"` define o texto para verde brilhante e o fundo azul
@@ -200,12 +200,12 @@ Esta é a lista de opções de configuração em todo o prompt.
 | Opções            | Padrão                         | Descrição                                                                                                                                                                                               |
 | ----------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
 | `format`          | [link](#default-prompt-format) | Configura o formato do prompt.                                                                                                                                                                          |
-| `right_format`    | `''`                           | Veja [Ativa o prompt direito](/advanced-config/#enable-right-prompt)                                                                                                                                    |
+| `right_format`    | `''`                           | Veja [Ativa o prompt direito](../advanced-config/#enable-right-prompt)                                                                                                                                    |
 | `scan_timeout`    | `30`                           | Tempo limite para escanear arquivos (em milissegundos).                                                                                                                                                 |
 | `command_timeout` | `500`                          | Tempo limite de execução de comandos pelo starship (em milissegundos).                                                                                                                                  |
 | `add_newline`     | `true`                         | Insere linha vazia entre os prompts do shell.                                                                                                                                                           |
 | `palette`         | `''`                           | Define qual a paleta de cores de `palettes` será usada.                                                                                                                                                 |
-| `palettes`        | `{}`                           | Coleção de paletas de cores que atribuem [cores](/advanced-config/#style-strings) aos nomes definidos pelo usuário. Note que paletas de cores não podem referir-se a suas próprias definições de cores. |
+| `palettes`        | `{}`                           | Coleção de paletas de cores que atribuem [cores](../advanced-config/#style-strings) aos nomes definidos pelo usuário. Note que paletas de cores não podem referir-se a suas próprias definições de cores. |
 | `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

 ## Porque eu vejo alertas de `Executing command "..." timed out.`?

-O Starship executa comandos diferentes para recuperar as informações para exibir no prompt, por exemplo a versão de um programa ou o status atual do git. Para ter certeza de que o starship não travou durante uma execução destes comandos nos definimos um limite de tempo, se um comando ultrapassar este limite o starship vai parar a execução do comando e exibe o alerta acima, esse é um comportamento esperado. Este limite de tempo é configurado usando o [`command_timeout`key](/config/#prompt) então se você quiser você pode aumentar este limite. Você pode também seguir os passos para debugar para ver qual comando esta demorando e se você pode otimizar ele. Finalmente você pode definir a variável de ambiente `STARSHIP_LOG` para `error` para esconder estes alertas.
+O Starship executa comandos diferentes para recuperar as informações para exibir no prompt, por exemplo a versão de um programa ou o status atual do git. Para ter certeza de que o starship não travou durante uma execução destes comandos nos definimos um limite de tempo, se um comando ultrapassar este limite o starship vai parar a execução do comando e exibe o alerta acima, esse é um comportamento esperado. Este limite de tempo é configurado usando o [`command_timeout`key](../config/#prompt) então se você quiser você pode aumentar este limite. Você pode também seguir os passos para debugar para ver qual comando esta demorando e se você pode otimizar ele. Finalmente você pode definir a variável de ambiente `STARSHIP_LOG` para `error` para esconder estes alertas.

 ## Eu vejo símbolos que não entendo ou não esperado, o que isso significa?

@@ -40,11 +40,11 @@
 </p>

 <p align="center">
-  <a href="https://starship.rs">Site</a>
+  <a href="https://starship.rs/pt-BR">Site</a>
  ·
  <a href="#🚀-installation">Instalação</a>
  ·
-  <a href="https://starship.rs/config/">Configuração</a>
+  <a href="https://starship.rs/pt-BR/config/">Configuração</a>
 </p>

 <p align="center">
@@ -171,7 +171,7 @@
 - **Fácil:**Instalação rápida – comece a usar em minutos.

 <p align="center">
-<a href="https://starship.rs/config/"><strong>Consulte a documentação&nbsp;&nbsp;▶</strong></a>
+<a href="https://starship.rs/pt-BR/config/"><strong>Consulte a documentação&nbsp;&nbsp;▶</strong></a>
 </p>

 <a name="🚀-installation"></a>
@@ -5,7 +5,7 @@ Para instalar o starship, você precisa de duas coisas:
 1. O binário do **Starship** em seu computador
 1. Altere seu shell para usar o binário do starship como seu prompt alterando os scripts init

-Para a maioria dos usuários as instruções na [pagina principal](/guide/#🚀-installation) irá funcionar perfeitamente. No entanto para algumas plataformas mais especificas, instruções diferentes são necessárias.
+Para a maioria dos usuários as instruções na [pagina principal](../guide/#🚀-installation) irá funcionar perfeitamente. No entanto para algumas plataformas mais especificas, instruções diferentes são necessárias.

 Existem tantas plataformas que elas não cabem no arquivo README.md principal, então aqui estão algumas instruções de instalação para outras plataformas da comunidade. A sua não está aqui? Por favor, adicione-o aqui se você descobrir!

@@ -1,4 +1,4 @@
-[Retornar para Personalizações](./README.md#bracketed-segments)
+[Retornar para Personalizações](./#bracketed-segments)

 # Predefinições entre colchetes

@@ -14,4 +14,4 @@ starship preset bracketed-segments -o ~/.config/starship.toml

 [Clique para baixar o TOML](/presets/toml/bracketed-segments.toml)

-<<< @/.vuepress/public/presets/toml/bracketed-segments.toml
+<<< @/public/presets/toml/bracketed-segments.toml
@@ -1,4 +1,4 @@
-[Retornar para Personalizações](./README.md#gruvbox-rainbow)
+[Retornar para Personalizações](./#gruvbox-rainbow)

 # Gruvbox Rainbow Preset

@@ -18,4 +18,4 @@ starship preset gruvbox-rainbow -o ~/.config/starship.toml

 [Clique para baixar o TOML](/presets/toml/gruvbox-rainbow.toml)

-<<< @/.vuepress/public/presets/toml/gruvbox-rainbow.toml
+<<< @/public/presets/toml/gruvbox-rainbow.toml
@@ -1,4 +1,4 @@
-[Retornar para Personalizações](./README.md#jetpack)
+[Retornar para Personalizações](./#jetpack)

 # Jetpack Preset

@@ -21,4 +21,4 @@ starship preset jetpack -o ~/.config/starship.toml

 [Clique para baixar o TOML](/presets/toml/jetpack.toml)

-<<< @/.vuepress/public/presets/toml/jetpack.toml
+<<< @/public/presets/toml/jetpack.toml
@@ -1,4 +1,4 @@
-[Retornar para Personalizações](./README.md#nerd-font-symbols)
+[Retornar para Personalizações](./#nerd-font-symbols)

 # Símbolos Nerd Font

@@ -18,4 +18,4 @@ starship preset nerd-font-symbols -o ~/.config/starship.toml

 [Clique para baixar o 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 @@
-[Retornar para Personalizações](./README.md#no-empty-icons)
+[Retornar para Personalizações](./#no-empty-icons)

 # Predefinição Nenhum Ícones Vazios

@@ -14,4 +14,4 @@ starship preset no-empty-icons -o ~/.config/starship.toml

 [Clique para baixar o 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 @@
-[Retornar para Personalizações](./README.md#no-nerd-fonts)
+[Retornar para Personalizações](./#no-nerd-fonts)

 # Predefinição sem Nerd Fonts

@@ -16,4 +16,4 @@ starship preset no-nerd-font -o ~/.config/starship.toml

 [Clique para baixar o 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 @@
-[Retornar para Predefinições](./README.md#no-runtime-versions)
+[Retornar para Predefinições](./#no-runtime-versions)

 # Remover versão do runtime

@@ -14,4 +14,4 @@ starship preset no-runtime-versions -o ~/.config/starship.toml

 [Clique para baixar o 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 @@
-[Retornar para Personalizações](./README.md#pastel-powerline)
+[Retornar para Personalizações](./#pastel-powerline)

 # Pastel Powerline

@@ -18,4 +18,4 @@ starship preset pastel-powerline -o ~/.config/starship.toml

 [Clique para baixar o TOML](/presets/toml/pastel-powerline.toml)

-<<< @/.vuepress/public/presets/toml/pastel-powerline.toml
+<<< @/public/presets/toml/pastel-powerline.toml
@@ -1,4 +1,4 @@
-[Retornar para Predefinições](./README.md#plain-text-symbols)
+[Retornar para Predefinições](./#plain-text-symbols)

 ## Personalização de símbolos de texto simples

@@ -14,4 +14,4 @@ starship preset plain-text-symbols -o ~/.config/starship.toml

 [Clique para baixar o 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 @@
-[Retornar para Personalizações](./README.md#pure)
+[Retornar para Personalizações](./#pure)

 # Personalização do prompt do terminal com Pure

@@ -14,4 +14,4 @@ starship preset pure-preset -o ~/.config/starship.toml

 [Clique para baixar o TOML](/presets/toml/pure-preset.toml)

-<<< @/.vuepress/public/presets/toml/pure-preset.toml
+<<< @/public/presets/toml/pure-preset.toml
@@ -1,4 +1,4 @@
-[Retornar para Personalizações](./README.md#pastel-powerline)
+[Retornar para Personalizações](./#pastel-powerline)

 # Predifinição Tokyo Night

@@ -18,4 +18,4 @@ starship preset tokyo-night -o ~/.config/starship.toml

 [Clique para baixar o TOML](/presets/toml/tokyo-night.toml)

-<<< @/.vuepress/public/presets/toml/tokyo-night.toml
+<<< @/public/presets/toml/tokyo-night.toml