haskal
/
starship
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

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 2024-03-03 17:55:30 +01:00 committed by GitHub
parent 421b358c32
commit 7485c90c9f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
424 changed files with 2893 additions and 27713 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
.github/workflows/format-workflow.yml vendored
View File

@ -40,3 +40,26 @@ jobs:
with: with:
githubToken: ${{ secrets.GITHUB_TOKEN }} githubToken: ${{ secrets.GITHUB_TOKEN }}
pattern: docs/[a-z][a-z][a-z]?-[A-Z][A-Z]?/.* pattern: docs/[a-z][a-z][a-z]?-[A-Z][A-Z]?/.*
# Vitepress build
vitepress:
name: Vitepress [Build]
runs-on: ubuntu-latest
steps:
- name: Setup | Checkout
uses: actions/checkout@v4
- name: Setup | Node
uses: actions/setup-node@v4
with:
node-version: 20
cache: 'npm'
cache-dependency-path: docs/package-lock.json
- name: Setup | Install dependencies
run: npm install
working-directory: docs
- name: Build | Build docs site
run: npm run build
working-directory: docs

6
.github/workflows/publish-docs.yml vendored
View File

@ -10,9 +10,9 @@ jobs:
uses: actions/checkout@v4 uses: actions/checkout@v4
- name: Setup | Node - name: Setup | Node
uses: actions/setup-node@v3 uses: actions/setup-node@v4
with: with:
node-version: 16 node-version: 20
cache: 'npm' cache: 'npm'
cache-dependency-path: docs/package-lock.json cache-dependency-path: docs/package-lock.json
@ -27,7 +27,7 @@ jobs:
- name: Publish - name: Publish
uses: netlify/actions/cli@master uses: netlify/actions/cli@master
with: with:
args: deploy --prod --dir=docs/.vuepress/dist args: deploy --prod --dir=docs/.vitepress/dist
env: env:
NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }} NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }} NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}

4
.github/workflows/release.yml vendored
View File

@ -215,9 +215,9 @@ jobs:
xcrun notarytool store-credentials "$KEYCHAIN_ENTRY" --team-id "$APPLEID_TEAMID" --apple-id "$APPLEID_USERNAME" --password "$APPLEID_PASSWORD" --keychain "$KEYCHAIN_PATH" xcrun notarytool store-credentials "$KEYCHAIN_ENTRY" --team-id "$APPLEID_TEAMID" --apple-id "$APPLEID_USERNAME" --password "$APPLEID_PASSWORD" --keychain "$KEYCHAIN_PATH"
- name: Setup | Node - name: Setup | Node
uses: actions/setup-node@v3 uses: actions/setup-node@v4
with: with:
node-version: 16 node-version: 20
- name: Notarize | Build docs - name: Notarize | Build docs
run: | run: |

3
.gitignore vendored
View File

@ -27,7 +27,8 @@ Cargo.lock
# Compiled files for documentation # Compiled files for documentation
docs/node_modules docs/node_modules
docs/.vuepress/dist/ docs/.vitepress/dist/
docs/.vitepress/cache/
# Ignore pkg files within the install directory # Ignore pkg files within the install directory
install/**/*.pkg install/**/*.pkg

6
CONTRIBUTING.md
View File

@ -251,7 +251,7 @@ Changes to documentation can be viewed in a rendered state from the GitHub PR pa
(go to the CI section at the bottom of the page and look for "deploy preview", then (go to the CI section at the bottom of the page and look for "deploy preview", then
click on "details"). If you want to view changes locally as well, follow these steps. click on "details"). If you want to view changes locally as well, follow these steps.
After cloning the project, you can do the following to run the VuePress website on your local machine: After cloning the project, you can do the following to run the VitePress website on your local machine:
1. `cd` into the `/docs` directory. 1. `cd` into the `/docs` directory.
2. Install the project dependencies: 2. Install the project dependencies:
@ -266,7 +266,7 @@ After cloning the project, you can do the following to run the VuePress website
npm run dev npm run dev
``` ```
Once setup is complete, you can refer to VuePress documentation on the actual implementation here: <https://vuepress.vuejs.org/guide/>. Once setup is complete, you can refer to VitePress documentation on the actual implementation here: <https://vitepress.dev/guide/getting-started>.
## Git/GitHub workflow ## Git/GitHub workflow
@ -292,7 +292,7 @@ everyone remember what they are. Don't worry: most of them are quite simple!
appropriate--this is a bare minimum). appropriate--this is a bare minimum).
- [ ] Add the variable to the appropriate location in the "Default Prompt - [ ] Add the variable to the appropriate location in the "Default Prompt
Format" section of the documentation Format" section of the documentation
- [ ] Add an appropriate choice of options to each preset in `docs/.vuepress/public/presets/toml` - [ ] Add an appropriate choice of options to each preset in `docs/public/presets/toml`
- [ ] Update the config file schema by running `cargo run --features config-schema -- config-schema > .github/config-schema.json` - [ ] Update the config file schema by running `cargo run --features config-schema -- config-schema > .github/config-schema.json`
- [ ] Create configs structs/traits in `src/configs/<module>.rs` and add the - [ ] Create configs structs/traits in `src/configs/<module>.rs` and add the
following: following:

4
build.rs
View File

@ -19,8 +19,8 @@ fn main() -> SdResult<()> {
} }
fn gen_presets_hook(mut file: &File) -> SdResult<()> { fn gen_presets_hook(mut file: &File) -> SdResult<()> {
println!("cargo:rerun-if-changed=docs/.vuepress/public/presets/toml"); println!("cargo:rerun-if-changed=docs/public/presets/toml");
let paths = fs::read_dir("docs/.vuepress/public/presets/toml")?; let paths = fs::read_dir("docs/public/presets/toml")?;
let mut sortedpaths = paths.collect::<io::Result<Vec<_>>>()?; let mut sortedpaths = paths.collect::<io::Result<Vec<_>>>()?;
sortedpaths.sort_by_key(std::fs::DirEntry::path); sortedpaths.sort_by_key(std::fs::DirEntry::path);

565
docs/.vuepress/config.ts → docs/.vitepress/config.mts
View File

@ -1,98 +1,343 @@
import { defineConfig, SidebarConfigArray } from "vuepress/config"; import { defineConfig } from "vitepress";
const sidebar = (lang, override = {}): SidebarConfigArray => const sidebar = (lang: string | undefined, override = {}) =>
[ [
"", // "Home", which should always have a override { page: "guide", text: "Guide" }, // README, which should always have a override
"guide", // README, which should always have a override
// Overrides for any page below is an inconsistency between the sidebar title and page title // Overrides for any page below is an inconsistency between the sidebar title and page title
"installing", { page: "installing", text: "Installation" },
"config", { page: "config", text: "Configuration" },
"advanced-config", { page: "advanced-config", text: "Advanced Configuration" },
"faq", { page: "faq", text: "FAQ" },
"presets", { page: "presets", text: "Presets" },
].map(page => { ].map(item => {
let path = "/"; let path = "/";
if (lang) { if (lang) {
path += `${lang}/`; path += `${lang}/`;
} }
if (page) { if (item.page) {
path += `${page}/`; path += `${item.page}/`;
} }
// If no override is set for current page, let VuePress fallback to page title // If no override is set for current page, let VitePress fallback to page title
return page in override ? [path, override[page]] : path; return { link: path, text: override?.[item.page] ?? item.text };
}); });
module.exports = defineConfig({ const editLinkPattern = 'https://github.com/starship/starship/edit/master/docs/:path';
export default defineConfig({
locales: { locales: {
"/": { root: {
label: "English",
lang: "en-US", lang: "en-US",
title: "Starship", title: "Starship",
description: "The minimal, blazing-fast, and infinitely customizable prompt for any shell!", description: "The minimal, blazing-fast, and infinitely customizable prompt for any shell!",
themeConfig: {
// Custom navbar values
nav: [{ text: "Configuration", link: "/config/"}],
// Custom sidebar values
sidebar: sidebar("", {
guide: "Guide",
}),
// Enable edit links
editLink: {
text: "Edit this page on GitHub",
pattern: editLinkPattern,
}, },
"/de-DE/": { }
},
"de-DE": {
label: "Deutsch",
lang: "de-DE", lang: "de-DE",
title: "Starship", title: "Starship",
description: "Minimale, super schnelle und unendlich anpassbare Prompt für jede Shell!", description: "Minimale, super schnelle und unendlich anpassbare Prompt für jede Shell!",
themeConfig: {
// text for the language dropdown
langMenuLabel: "Sprachen",
returnToTopLabel: "Zurück zum Seitenanfang",
sidebarMenuLabel: "Menü",
nav: [{ text: "Konfiguration", link: "/de-DE/config/" }],
// Custom sidebar values
sidebar: sidebar("de-DE", {
guide: "Anleitung",
installing: "Erweiterte Installation",
faq: "Häufig gestellte Fragen",
presets: "Konfigurations-Beispiele",
}),
editLink: {
text: "Bearbeite diese Seite auf GitHub",
pattern: editLinkPattern,
}, },
"/es-ES/": { }
},
"es-ES": {
label: "Español",
lang: "es-ES", lang: "es-ES",
title: "Starship", title: "Starship",
description: description:
"¡El prompt minimalista, ultrarápido e infinitamente personalizable para cualquier intérprete de comandos!", "¡El prompt minimalista, ultrarápido e infinitamente personalizable para cualquier intérprete de comandos!",
themeConfig: {
// text for the language dropdown
langMenuLabel: "Idiomas",
returnToTopLabel: "Volver arriba",
sidebarMenuLabel: "Menú",
// Custom navbar values
nav: [{ text: "Configuración", link: "/es-ES/config/" }],
// Custom sidebar values
sidebar: sidebar("es-ES", {
guide: "Guía",
installing: "Instalación avanzada",
faq: "Preguntas frecuentes",
presets: "Ajustes predeterminados",
}),
editLink: {
text: "Edita esta página en GitHub",
pattern: editLinkPattern,
}, },
"/fr-FR/": { },
},
"fr-FR": {
label: "Français",
lang: "fr-FR", lang: "fr-FR",
title: "Starship", title: "Starship",
description: "L'invite minimaliste, ultra-rapide et personnalisable à l'infini pour n'importe quel shell !", description: "L'invite minimaliste, ultra-rapide et personnalisable à l'infini pour n'importe quel shell !",
themeConfig: {
// text for the language dropdown
langMenuLabel: "Langues",
returnToTopLabel: "Retour en haut",
// Custom navbar values
nav: [{ text: "Configuration", link: "/fr-FR/config/" }],
// Custom sidebar values
sidebar: sidebar("fr-FR", {
guide: "Guide",
installing: "Installation avancée",
}),
editLink: {
text: "Éditez cette page sur GitHub",
pattern: editLinkPattern,
}, },
"/id-ID/": { },
},
"id-ID": {
label: "Bahasa Indonesia",
lang: "id-ID", lang: "id-ID",
title: "Starship", title: "Starship",
description: "Prompt yang minimal, super cepat, dan dapat disesuaikan tanpa batas untuk shell apa pun!", description: "Prompt yang minimal, super cepat, dan dapat disesuaikan tanpa batas untuk shell apa pun!",
themeConfig: {
// text for the language dropdown
langMenuLabel: "Languages",
returnToTopLabel: "Kembali ke atas",
// Custom navbar values
nav: [{ text: "Konfigurasi", link: "/id-ID/config/" }],
// Custom sidebar values
sidebar: sidebar("id-ID", {
guide: "Petunjuk",
installing: "Advanced Installation",
faq: "Pertanyaan Umum",
presets: "Prasetel",
}),
editLink: {
text: "Sunting halaman ini di Github",
pattern: editLinkPattern,
}, },
"/it-IT/": { },
},
"it-IT": {
label: "Italiano",
lang: "it-IT", lang: "it-IT",
title: "Starship", title: "Starship",
description: "Il prompt minimalista, super veloce e infinitamente personalizzabile per qualsiasi shell!", description: "Il prompt minimalista, super veloce e infinitamente personalizzabile per qualsiasi shell!",
themeConfig: {
// text for the language dropdown
langMenuLabel: "Languages",
returnToTopLabel: "Torna all'inizio",
// Custom navbar values
nav: [{ text: "Configuration", link: "/it-IT/config/" }],
// Custom sidebar values
sidebar: sidebar("it-IT", {
guide: "Guide",
installing: "Installazione Avanzata",
}),
editLink: {
text: "Modifica questa pagina in Github",
pattern: editLinkPattern,
}, },
"/ja-JP/": { },
},
"ja-JP": {
label: "日本語",
lang: "ja-JP", lang: "ja-JP",
title: "Starship", title: "Starship",
description: "シェル用の最小限の、非常に高速で、無限にカスタマイズ可能なプロンプトです！", description: "シェル用の最小限の、非常に高速で、無限にカスタマイズ可能なプロンプトです！",
themeConfig: {
// text for the language dropdown
langMenuLabel: "言語",
returnToTopLabel: "ページの先頭へ",
sidebarMenuLabel: "メニュー",
// Custom navbar values
nav: [{ text: "設定", link: "/ja-JP/config/" }],
// Custom sidebar values
sidebar: sidebar("ja-JP", {
guide: "ガイド",
installing: "高度なインストール",
}),
editLink: {
text: "GitHub で編集する",
pattern: editLinkPattern,
}, },
"/pt-BR/": { },
},
"pt-BR": {
label: "Português do Brasil",
lang: "pt-BR", lang: "pt-BR",
title: "Starship", title: "Starship",
description: description:
"O prompt minimalista, extremamente rápido e infinitamente personalizável para qualquer shell!", "O prompt minimalista, extremamente rápido e infinitamente personalizável para qualquer shell!",
themeConfig: {
// text for the language dropdown
langMenuLabel: "Languages",
returnToTopLabel: "Voltar ao topo",
// Custom navbar values
nav: [{ text: "Configuração", link: "/pt-BR/config/" }],
// Custom sidebar values
sidebar: sidebar("pt-BR", {
guide: "Guia",
installing: "Instalação avançada",
faq: "Perguntas frequentes",
presets: "Predefinições",
}),
editLink: {
text: "Edite esta página no Github",
pattern: editLinkPattern,
}, },
"/ru-RU/": { },
},
"ru-RU": {
label: "Русский",
lang: "ru-RU", lang: "ru-RU",
title: "Starship", title: "Starship",
description: "Минималистичная, быстрая и бесконечно настраиваемая командная строка для любой оболочки!", description: "Минималистичная, быстрая и бесконечно настраиваемая командная строка для любой оболочки!",
themeConfig: {
// text for the language dropdown
langMenuLabel: "Языки",
returnToTopLabel: "Наверх",
sidebarMenuLabel: "Меню",
// Custom navbar values
nav: [{ text: "Настройка", link: "/ru-RU/config/" }],
// Custom sidebar values
sidebar: sidebar("ru-RU", {
guide: "Руководство",
installing: "Advanced Installation",
config: "Настройка",
"advanced-config": "Расширенная Настройка",
faq: "Часто Задаваемые Вопросы",
}),
editLink: {
text: "Редактировать эту страницу на GitHub",
pattern: editLinkPattern,
}, },
"/uk-UA/": { },
},
"uk-UA": {
label: "Українська",
lang: "uk-UA", lang: "uk-UA",
title: "Starship", title: "Starship",
description: "Простий, супер швидкий та безмежно адаптивний командний рядок для будь-якої оболонки!", description: "Простий, супер швидкий та безмежно адаптивний командний рядок для будь-якої оболонки!",
themeConfig: {
// text for the language dropdown
langMenuLabel: "Мови",
returnToTopLabel: "Догори",
sidebarMenuLabel: "Меню",
// Custom navbar values
nav: [{ text: "Налаштування", link: "/uk-UA/config/" }],
// Custom sidebar values
sidebar: sidebar("uk-UA", {
guide: "Керівництво",
installing: "Розширене встановлення",
config: "Налаштування",
"advanced-config": "Розширені налаштування",
faq: "Часті питання",
presets: "Шаблони",
}),
editLink: {
text: "Редагувати цю сторінку на GitHub",
pattern: editLinkPattern,
}, },
"/vi-VN/": { },
},
"vi-VN": {
label: "Tiếng Việt",
lang: "vi-VN", lang: "vi-VN",
title: "Starship", title: "Starship",
description: "Nhỏ gọn, cực nhanh, và khả năng tuỳ chỉnh vô hạn prompt cho bất kì shell nào!", description: "Nhỏ gọn, cực nhanh, và khả năng tuỳ chỉnh vô hạn prompt cho bất kì shell nào!",
themeConfig: {
// text for the language dropdown
langMenuLabel: "Ngôn ngữ",
returnToTopLabel: "Quay lại đầu trang",
// Custom navbar values
nav: [{ text: "Cấu hình", link: "/vi-VN/config/" }],
// Custom sidebar values
sidebar: sidebar("vi-VN", {
guide: "Hướng dẫn",
installing: "Cài đặt nâng cao",
faq: "Các hỏi thường gặp",
}),
editLink: {
text: "Chỉnh sửa trang này trên GitHub",
pattern: editLinkPattern,
}, },
"/zh-CN/": { },
},
"zh-CN": {
label: "简体中文",
lang: "zh-CN", lang: "zh-CN",
title: "Starship", title: "Starship",
description: "轻量级、反应迅速，可定制的高颜值终端！", description: "轻量级、反应迅速，可定制的高颜值终端！",
themeConfig: {
// text for the language dropdown
langMenuLabel: "语言",
returnToTopLabel: "返回顶部",
sidebarMenuLabel: "目录",
// Custom navbar values
nav: [{ text: "配置", link: "/zh-CN/config/" }],
// Custom sidebar values
sidebar: sidebar("zh-CN", {
guide: "指南",
installing: "高级安装",
presets: "社区配置分享",
}),
editLink: {
text: "在 GitHub 上修改此页",
pattern: editLinkPattern,
}, },
"/zh-TW/": { },
},
"zh-TW": {
label: "繁體中文",
lang: "zh-TW", lang: "zh-TW",
title: "Starship", title: "Starship",
description: "適合任何 shell 的最小、極速、無限客製化的提示字元！", description: "適合任何 shell 的最小、極速、無限客製化的提示字元！",
themeConfig: {
// text for the language dropdown
langMenuLabel: "語言",
returnToTopLabel: "返回頂部",
sidebarMenuLabel: "目錄",
// Custom navbar values
nav: [{ text: "設定", link: "/zh-TW/config/" }],
// Custom sidebar values
sidebar: sidebar("zh-TW", {
guide: "指引",
installing: "進階安裝",
}),
editLink: {
text: "在 GitHub 上修改此頁面",
pattern: editLinkPattern,
},
},
}, },
}, },
// prettier-ignore // prettier-ignore
@ -120,7 +365,7 @@ module.exports = defineConfig({
[ [
"script", "script",
{ {
async: true, async: '',
src: "https://www.googletagmanager.com/gtag/js?id=G-N3M0VJ9NL6", src: "https://www.googletagmanager.com/gtag/js?id=G-N3M0VJ9NL6",
}, },
], ],
@ -130,245 +375,41 @@ module.exports = defineConfig({
"window.dataLayer = window.dataLayer || [];\nfunction gtag(){dataLayer.push(arguments);}\ngtag('js', new Date());\ngtag('config', 'G-N3M0VJ9NL6');", "window.dataLayer = window.dataLayer || [];\nfunction gtag(){dataLayer.push(arguments);}\ngtag('js', new Date());\ngtag('config', 'G-N3M0VJ9NL6');",
], ],
], ],
evergreen: true, sitemap: {
theme: "default-prefers-color-scheme", hostname: 'https://starship.rs'
},
vite: {
resolve: {
preserveSymlinks: true
}
},
cleanUrls: true,
markdown: {
theme: "github-dark"
},
ignoreDeadLinks: [
/\/toml\/.*/,
],
// VitePress doesn't support README.md as index files
// Rewrite README.md to index.md at different levels
rewrites: {
"README.md": "index.md",
":c0/README.md": ":c0/index.md",
":c0/:c1/README.md": ":c0/:c1/index.md",
":c0/:c1/:c2/README.md": ":c0/:c1/:c2/index.md",
":c0/:c1/:c2/:c3/README.md": ":c0/:c1/:c2/:c3/index.md",
},
themeConfig: { themeConfig: {
logo: "/icon.png", logo: "/icon.png",
// the GitHub repo path socialLinks: [
repo: "starship/starship", { icon: 'github', link: 'https://github.com/starship/starship' },
// the label linking to the repo ],
repoLabel: "GitHub",
// if your docs are not at the root of the repo:
docsDir: "docs",
// defaults to false, set to true to enable
editLinks: true,
// enables Algolia DocSearch // enables Algolia DocSearch
algolia: { algolia: {
apiKey: "44118471f56286dcda7db941a043370d", apiKey: "44118471f56286dcda7db941a043370d",
indexName: "starship", indexName: "starship",
appId: "M3XUO3SQOR", appId: "M3XUO3SQOR",
}, },
locales: { }
"/": {
// text for the language dropdown
selectText: "Languages",
// label for this locale in the language dropdown
label: "English",
// Custom text for edit link. Defaults to "Edit this page"
editLinkText: "Edit this page on GitHub",
// Custom navbar values
nav: [{ text: "Configuration", link: "/config/" }],
// Custom sidebar values
sidebar: sidebar("", {
guide: "Guide",
}),
},
"/de-DE/": {
// text for the language dropdown
selectText: "Sprachen",
// label for this locale in the language dropdown
label: "Deutsch",
// Custom text for edit link. Defaults to "Edit this page"
editLinkText: "Bearbeite diese Seite auf GitHub",
// Custom navbar values
nav: [{ text: "Konfiguration", link: "/de-DE/config/" }],
// Custom sidebar values
sidebar: sidebar("de-DE", {
guide: "Anleitung",
installing: "Erweiterte Installation",
faq: "Häufig gestellte Fragen",
presets: "Konfigurations-Beispiele",
}),
},
"/es-ES/": {
// text for the language dropdown
selectText: "Idiomas",
// label for this locale in the language dropdown
label: "Español",
// Custom text for edit link. Defaults to "Edit this page"
editLinkText: "Edita esta página en GitHub",
// Custom navbar values
nav: [{ text: "Configuración", link: "/es-ES/config/" }],
// Custom sidebar values
sidebar: sidebar("es-ES", {
guide: "Guía",
installing: "Instalación avanzada",
faq: "Preguntas frecuentes",
presets: "Ajustes predeterminados",
}),
},
"/fr-FR/": {
// text for the language dropdown
selectText: "Langues",
// label for this locale in the language dropdown
label: "Français",
// Custom text for edit link. Defaults to "Edit this page"
editLinkText: "Éditez cette page sur GitHub",
// Custom navbar values
nav: [{ text: "Configuration", link: "/fr-FR/config/" }],
// Custom sidebar values
sidebar: sidebar("fr-FR", {
guide: "Guide",
installing: "Installation avancée",
}),
},
"/id-ID/": {
// text for the language dropdown
selectText: "Languages",
// label for this locale in the language dropdown
label: "Bahasa Indonesia",
// Custom text for edit link. Defaults to "Edit this page"
editLinkText: "Sunting halaman ini di Github",
// Custom navbar values
nav: [{ text: "Konfigurasi", link: "/id-ID/config/" }],
// Custom sidebar values
sidebar: sidebar("id-ID", {
guide: "Petunjuk",
installing: "Advanced Installation",
faq: "Pertanyaan Umum",
presets: "Prasetel",
}),
},
"/it-IT/": {
// text for the language dropdown
selectText: "Languages",
// label for this locale in the language dropdown
label: "Italiano",
// Custom text for edit link. Defaults to "Edit this page"
editLinkText: "Modifica questa pagina in Github",
// Custom navbar values
nav: [{ text: "Configuration", link: "/it-IT/config/" }],
// Custom sidebar values
sidebar: sidebar("it-IT", {
guide: "Guide",
installing: "Installazione Avanzata",
}),
},
"/ja-JP/": {
// text for the language dropdown
selectText: "言語",
// label for this locale in the language dropdown
label: "日本語",
// Custom text for edit link. Defaults to "Edit this page"
editLinkText: "GitHub で編集する",
// Custom navbar values
nav: [{ text: "設定", link: "/ja-JP/config/" }],
// Custom sidebar values
sidebar: sidebar("ja-JP", {
guide: "ガイド",
installing: "高度なインストール",
}),
},
"/pt-BR/": {
// text for the language dropdown
selectText: "Languages",
// label for this locale in the language dropdown
label: "Português do Brasil",
// Custom text for edit link. Defaults to "Edit this page"
editLinkText: "Edite esta página no Github",
// Custom navbar values
nav: [{ text: "Configuração", link: "/pt-BR/config/" }],
// Custom sidebar values
sidebar: sidebar("pt-BR", {
guide: "Guia",
installing: "Instalação avançada",
faq: "Perguntas frequentes",
presets: "Predefinições",
}),
},
"/ru-RU/": {
// text for the language dropdown
selectText: "Языки",
// label for this locale in the language dropdown
label: "Русский",
// Custom text for edit link. Defaults to "Edit this page"
editLinkText: "Редактировать эту страницу на GitHub",
// Custom navbar values
nav: [{ text: "Настройка", link: "/ru-RU/config/" }],
// Custom sidebar values
sidebar: sidebar("ru-RU", {
guide: "Руководство",
installing: "Advanced Installation",
config: "Настройка",
"advanced-config": "Расширенная Настройка",
faq: "Часто Задаваемые Вопросы",
}),
},
"/uk-UA/": {
// text for the language dropdown
selectText: "Мови",
// label for this locale in the language dropdown
label: "Українська",
// Custom text for edit link. Defaults to "Edit this page"
editLinkText: "Редагувати цю сторінку на GitHub",
// Custom navbar values
nav: [{ text: "Налаштування", link: "/uk-UA/config/" }],
// Custom sidebar values
sidebar: sidebar("uk-UA", {
guide: "Керівництво",
installing: "Розширене встановлення",
config: "Налаштування",
"advanced-config": "Розширені налаштування",
faq: "Часті питання",
presets: "Шаблони",
}),
},
"/vi-VN/": {
// text for the language dropdown
selectText: "Ngôn ngữ",
// label for this locale in the language dropdown
label: "Tiếng Việt",
// Custom text for edit link. Defaults to "Edit this page"
editLinkText: "Chỉnh sửa trang này trên GitHub",
// Custom navbar values
nav: [{ text: "Cấu hình", link: "/vi-VN/config/" }],
// Custom sidebar values
sidebar: sidebar("vi-VN", {
guide: "Hướng dẫn",
installing: "Cài đặt nâng cao",
faq: "Các hỏi thường gặp",
}),
},
"/zh-TW/": {
// text for the language dropdown
selectText: "語言",
// label for this locale in the language dropdown
label: "繁體中文",
// Custom text for edit link. Defaults to "Edit this page"
editLinkText: "在 GitHub 上修改此頁面",
// Custom navbar values
nav: [{ text: "設定", link: "/zh-TW/config/" }],
// Custom sidebar values
sidebar: sidebar("zh-TW", {
guide: "指引",
installing: "進階安裝",
}),
},
"/zh-CN/": {
// text for the language dropdown
selectText: "语言",
// label for this locale in the language dropdown
label: "简体中文",
// Custom text for edit link. Defaults to "Edit this page"
editLinkText: "在 GitHub 上修改此页",
// Custom navbar values
nav: [{ text: "配置", link: "/zh-CN/config/" }],
// Custom sidebar values
sidebar: sidebar("zh-CN", {
guide: "指南",
installing: "高级安装",
presets: "社区配置分享",
}),
},
},
},
plugins: [
[
"vuepress-plugin-sitemap",
{
hostname: "https://starship.rs",
},
],
["vuepress-plugin-code-copy", true],
],
}); });

97
docs/.vitepress/theme/index.css Normal file
View File

@ -0,0 +1,97 @@
.VPHero .container {
flex-direction: column;
text-align: center !important;
gap: 10px;
}
.VPHero .image {
order: 0;
margin: 0;
}
.VPHero .image-container {
transform: none;
height: auto;
}
.VPHero .image img {
max-height: 130px;
max-width: none;
position: static;
transform: none;
}
.VPHero .container .actions {
justify-content: center !important;
}
.VPHero .main {
margin: 0 auto;
}
.demo-video {
max-width: 700px;
width: 100%;
margin: 50px auto;
border-radius: 6px;
}
.action-button {
background-color: #dd0b78 !important;
border-bottom: #c6096b !important;
}
p[align="center"] img {
display: inline-block;
}
p[align="center"] img[height="20"] {
height: 20px;
}
@font-face {
font-family: 'Nerd Font';
src: url("/nerd-font.woff2") format("woff2");
font-weight: 400;
font-style: normal;
unicode-range: U+e000-f8ff, U+f0000-fffff, U+100000-10ffff;
}
code {
overflow-wrap: break-word;
}
.vp-doc [class*='language-']>button.copy {
top: unset;
bottom: 12px;
}
:root {
--vp-font-family-mono: 'Nerd Font', source-code-pro, SFMono-Regular, 'SF Mono', Menlo, Monaco, Consolas, 'Liberation Mono', 'Courier New', monospace;
--vp-c-brand-1: #9b0854;
--vp-c-brand-2: #f31186;
--vp-c-brand-3: #dd0b78;
--vp-c-brand-soft: rgba(221, 11, 120, 0.14);
/* The following colors were extracted from the dark variant of the default VitePress theme
* Styled variables from: https://github.com/vuejs/vitepress/blob/main/src/client/theme-default/styles/vars.css#L319-L362
*/
--vp-code-block-bg: #282c34;
--vp-code-color: #282c34;
--vp-code-block-divider-color: #000;
--vp-code-lang-color: rgba(235, 235, 245, 0.38);
--vp-code-line-highlight-color: rgba(101, 117, 133, 0.16);
--vp-code-line-number-color: rgba(235, 235, 245, 0.38);
--vp-code-copy-code-border-color: #2e2e32;
--vp-code-copy-code-bg: #202127;
--vp-code-copy-code-hover-border-color: #2e2e32;
--vp-code-copy-code-hover-bg: #1b1b1f;
--vp-code-copy-code-active-text: rgba(235, 235, 245, 0.6);
}
.dark {
--vp-c-brand-1: #ff70cd;
--vp-c-brand-2: #ff14ad;
--vp-c-brand-3: #ff33b8;
--vp-c-brand-soft: rgba(255, 51, 184, 0.14);
--vp-code-color: #fff;
}

4
docs/.vitepress/theme/index.js Normal file
View File

@ -0,0 +1,4 @@
import DefaultTheme from "vitepress/theme";
import "./index.css";
export default DefaultTheme;

1
docs/.vuepress/public/config-schema.json
View File

@ -1 +0,0 @@
../../../.github/config-schema.json

1
docs/.vuepress/public/icon.png
View File

@ -1 +0,0 @@
../../../media/icon.png

1
docs/.vuepress/public/install.sh
View File

@ -1 +0,0 @@
../../../install/install.sh

1
docs/.vuepress/public/logo.png
View File

@ -1 +0,0 @@
../../../media/logo.png

1
docs/.vuepress/public/logo.svg
View File

@ -1 +0,0 @@
../../../media/logo.svg

BIN
docs/.vuepress/public/nerd-font.woff2
View File

Binary file not shown.

38
docs/.vuepress/styles/index.styl
View File

@ -1,38 +0,0 @@
.home .hero img
max-width: 500px !important
min-width: 300px
width: 100%
.center
margin 0 auto;
width: 80%
.demo-video
width: 100%
margin: 50px 0
border-radius: 6px
.hero
margin: 150px 25px 70px
.action-button
background-color: #dd0b78 !important
border-bottom: #c6096b !important
@font-face
font-family: 'Nerd Font';
src: url("/nerd-font.woff2") format("woff2");
font-weight: 400;
font-style: normal
code
font-family: 'Nerd Font', source-code-pro, Menlo, Monaco, Consolas, "Courier New", monospace;
overflow-wrap: break-word
@media (prefers-color-scheme: light)
:root
--languageTextColor: rgba(255,255,255,0.4)
.code-copy
position: absolute
right: 0
bottom: 1px

6
docs/.vuepress/styles/palette.styl
View File

@ -1,6 +0,0 @@
$accentColor = #DD0B78
$accentDarkColor = #ff33b8
$textColor = #2c3e50
$borderColor = #eaecef
$codeBgLightColor = #282c34
$preTextLightColor = #fff

17
docs/README.md
View File

@ -1,10 +1,13 @@
--- ---
home: true layout: home
heroImage: /logo.svg hero:
heroText: null image: /logo.svg
text: null
tagline: The minimal, blazing-fast, and infinitely customizable prompt for any shell! tagline: The minimal, blazing-fast, and infinitely customizable prompt for any shell!
actionText: Get Started → actions:
actionLink: ./guide/ - theme: brand
text: Get Started →
link: ./guide/
features: features:
- title: Compatibility First - title: Compatibility First
details: Works on the most common shells on the most common operating systems. Use it everywhere! details: Works on the most common shells on the most common operating systems. Use it everywhere!
@ -19,12 +22,10 @@ metaTitle: "Starship: Cross-Shell Prompt"
description: 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, Tcsh, Elvish, Nu, Xonsh, Cmd, and PowerShell. description: 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, Tcsh, Elvish, Nu, Xonsh, Cmd, and PowerShell.
--- ---
<div class="center">
<video class="demo-video" muted autoplay loop playsinline> <video class="demo-video" muted autoplay loop playsinline>
<source src="/demo.webm" type="video/webm"> <source src="/demo.webm" type="video/webm">
<source src="/demo.mp4" type="video/mp4"> <source src="/demo.mp4" type="video/mp4">
</video> </video>
</div>
### Prerequisites ### Prerequisites
@ -51,6 +52,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
```sh ```sh
brew install starship brew install starship
``` ```
With [Winget](https://github.com/microsoft/winget-cli): With [Winget](https://github.com/microsoft/winget-cli):
```powershell ```powershell
@ -143,6 +145,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
::: :::
Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save -f ~/.cache/starship/init.nu starship init nu | save -f ~/.cache/starship/init.nu

2
docs/advanced-config/README.md
View File

@ -294,7 +294,7 @@ in `format` is also supported in `right_format`. The `$all` variable will only c
not explicitly used in either `format` or `right_format`. 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 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). 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. `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell, bash.

13
docs/ar-SA/README.md
View File

@ -1,10 +1,13 @@
--- ---
home: true layout: home
heroImage: /logo.svg hero:
heroText: image: /logo.svg
text: null
tagline: التخصيص البسيط و السريع و الغير محدود لي ال"shell"! tagline: التخصيص البسيط و السريع و الغير محدود لي ال"shell"!
actionText: البدء مع Starship ← actions:
actionLink: ./guide/ - theme: brand
text: البدء مع Starship ←
link: ./guide/
features: features:
- -
title: التوافق أولاً title: التوافق أولاً

2
docs/ar-SA/advanced-config/README.md
View File

@ -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`. 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. `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell, bash.

6
docs/ar-SA/config/README.md
View File

@ -158,7 +158,7 @@ In the second part, which is enclosed in a `()`, is a [style string](#style-stri
#### Style Strings #### 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 - `'fg:green bg:blue'` sets green text on a blue background
- `'bg:blue fg:bright-green'` sets bright 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 | الافتراضي | الوصف | | Option | الافتراضي | الوصف |
| ----------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | [link](#default-prompt-format) | Configure the format of the prompt. | | `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). | | `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). | | `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). |
| `add_newline` | `true` | Inserts blank line between shell prompts. | | `add_newline` | `true` | Inserts blank line between shell prompts. |
| `palette` | `''` | Sets which color palette from `palettes` to use. | | `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. | | `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. |
::: tip ::: tip

2
docs/ar-SA/faq/README.md
View File

@ -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? ## 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? ## I see symbols I don't understand or expect, what do they mean?

6
docs/ar-SA/guide/README.md
View File

@ -40,11 +40,11 @@
</p> </p>
<p align="center"> <p align="center">
<a href="https://starship.rs">الموقع</a> <a href="https://starship.rs/ar-SA">الموقع</a>
· ·
<a href="#🚀-installation">التثبيت</a> <a href="#🚀-installation">التثبيت</a>
· ·
<a href="https://starship.rs/config/">الإعدادات</a> <a href="https://starship.rs/ar-SA/config/">الإعدادات</a>
</p> </p>
<p align="center"> <p align="center">
@ -171,7 +171,7 @@
- **Easy:** سريع التثبيت – استخدمها في دقائق معدودة. - **Easy:** سريع التثبيت – استخدمها في دقائق معدودة.
<p align="center"> <p align="center">
<a href="https://starship.rs/config/"><strong>تصفّح مستندات Starship&nbsp;&nbsp;▶</strong></a> <a href="https://starship.rs/ar-SA/config/"><strong>تصفّح مستندات Starship&nbsp;&nbsp;▶</strong></a>
</p> </p>
<a name="🚀-installation"></a> <a name="🚀-installation"></a>

2
docs/ar-SA/installing/README.md
View File

@ -5,7 +5,7 @@
1. ثبت ملفات **starship** على جهازك 1. ثبت ملفات **starship** على جهازك
1. تنبيه موجه الأوامر بإن يقوم بجعل سطر الأوامر ل starship وذلك بتعديل كود الإبتداء 1. تنبيه موجه الأوامر بإن يقوم بجعل سطر الأوامر ل starship وذلك بتعديل كود الإبتداء
غالبية المستخدمين [الصفحة الرئيسية ](/guide/#🚀-installation) سوف تلبي احتياجاتهم. لكن، من أجل الاستخدام المتقدم، هناك حاجة لتوجيهات أخرى. غالبية المستخدمين [الصفحة الرئيسية ](../guide/#🚀-installation) سوف تلبي احتياجاتهم. لكن، من أجل الاستخدام المتقدم، هناك حاجة لتوجيهات أخرى.
هناك العديد من الحالات التي لا تلبي المعلومات في ملف README.md احتياجها ولذلك هذه بعض إرشادات التثبيت الإضافية مقدمة من مجتمع starship. إذا كانت لديك ملاحظة وقمت بحلها ولم تجد هذا الحل لها ضمن الحلول التالية، الرجاء أضفها هنا! هناك العديد من الحالات التي لا تلبي المعلومات في ملف README.md احتياجها ولذلك هذه بعض إرشادات التثبيت الإضافية مقدمة من مجتمع starship. إذا كانت لديك ملاحظة وقمت بحلها ولم تجد هذا الحل لها ضمن الحلول التالية، الرجاء أضفها هنا!

4
docs/ar-SA/presets/bracketed-segments.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#bracketed-segments) [Return to Presets](./#bracketed-segments)
# Bracketed Segments Preset # Bracketed Segments Preset
@ -14,4 +14,4 @@ starship preset bracketed-segments -o ~/.config/starship.toml
[Click to download TOML](/presets/toml/bracketed-segments.toml) [Click to download TOML](/presets/toml/bracketed-segments.toml)
<<< @/.vuepress/public/presets/toml/bracketed-segments.toml <<< @/public/presets/toml/bracketed-segments.toml

4
docs/ar-SA/presets/gruvbox-rainbow.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#gruvbox-rainbow) [Return to Presets](./#gruvbox-rainbow)
# Gruvbox Rainbow Preset # Gruvbox Rainbow Preset
@ -18,4 +18,4 @@ starship preset gruvbox-rainbow -o ~/.config/starship.toml
[Click to download TOML](/presets/toml/gruvbox-rainbow.toml) [Click to download TOML](/presets/toml/gruvbox-rainbow.toml)
<<< @/.vuepress/public/presets/toml/gruvbox-rainbow.toml <<< @/public/presets/toml/gruvbox-rainbow.toml

4
docs/ar-SA/presets/jetpack.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#jetpack) [Return to Presets](./#jetpack)
# Jetpack Preset # Jetpack Preset
@ -21,4 +21,4 @@ starship preset jetpack -o ~/.config/starship.toml
[Click to download TOML](/presets/toml/jetpack.toml) [Click to download TOML](/presets/toml/jetpack.toml)
<<< @/.vuepress/public/presets/toml/jetpack.toml <<< @/public/presets/toml/jetpack.toml

4
docs/ar-SA/presets/nerd-font.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#nerd-font-symbols) [Return to Presets](./#nerd-font-symbols)
# Nerd Font Symbols Preset # 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) [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

4
docs/ar-SA/presets/no-empty-icons.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#no-empty-icons) [Return to Presets](./#no-empty-icons)
# No Empty Icons Preset # 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) [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

4
docs/ar-SA/presets/no-nerd-font.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#no-nerd-fonts) [Return to Presets](./#no-nerd-fonts)
# No Nerd Fonts Preset # 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) [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

4
docs/ar-SA/presets/no-runtimes.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#no-runtime-versions) [Return to Presets](./#no-runtime-versions)
# No Runtime Versions Preset # 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) [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

4
docs/ar-SA/presets/pastel-powerline.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#pastel-powerline) [Return to Presets](./#pastel-powerline)
# Pastel Powerline Preset # Pastel Powerline Preset
@ -18,4 +18,4 @@ starship preset pastel-powerline -o ~/.config/starship.toml
[Click to download TOML](/presets/toml/pastel-powerline.toml) [Click to download TOML](/presets/toml/pastel-powerline.toml)
<<< @/.vuepress/public/presets/toml/pastel-powerline.toml <<< @/public/presets/toml/pastel-powerline.toml

4
docs/ar-SA/presets/plain-text.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#plain-text-symbols) [Return to Presets](./#plain-text-symbols)
## Plain Text Symbols Preset ## 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) [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

4
docs/ar-SA/presets/pure-preset.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#pure) [Return to Presets](./#pure)
# Pure Preset # Pure Preset
@ -14,4 +14,4 @@ starship preset pure-preset -o ~/.config/starship.toml
[Click to download TOML](/presets/toml/pure-preset.toml) [Click to download TOML](/presets/toml/pure-preset.toml)
<<< @/.vuepress/public/presets/toml/pure-preset.toml <<< @/public/presets/toml/pure-preset.toml

4
docs/ar-SA/presets/tokyo-night.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#pastel-powerline) [Return to Presets](./#pastel-powerline)
# Tokyo Night Preset # Tokyo Night Preset
@ -18,4 +18,4 @@ starship preset tokyo-night -o ~/.config/starship.toml
[Click to download TOML](/presets/toml/tokyo-night.toml) [Click to download TOML](/presets/toml/tokyo-night.toml)
<<< @/.vuepress/public/presets/toml/tokyo-night.toml <<< @/public/presets/toml/tokyo-night.toml

13
docs/bn-BD/README.md
View File

@ -1,10 +1,13 @@
--- ---
home: true layout: home
heroImage: /logo.svg hero:
heroText: image: /logo.svg
text: null
tagline: আপনার টার্মিনাল এর জন্য একটি সহজ, প্রচণ্ড দ্রুত এবং অশেষভাবে কাস্টমাইজ করার মতো সুবিধাসম্পন্ন একটি প্রম্প্ট! tagline: আপনার টার্মিনাল এর জন্য একটি সহজ, প্রচণ্ড দ্রুত এবং অশেষভাবে কাস্টমাইজ করার মতো সুবিধাসম্পন্ন একটি প্রম্প্ট!
actionText: Get Started → actions:
actionLink: ./guide/ - theme: brand
text: Get Started →
link: ./guide/
features: features:
- -
title: Compatibility First title: Compatibility First

2
docs/bn-BD/advanced-config/README.md
View File

@ -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`. 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. `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell, bash.

6
docs/bn-BD/config/README.md
View File

@ -158,7 +158,7 @@ For example:
#### Style Strings #### 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 - `'fg:green bg:blue'` sets green text on a blue background
- `'bg:blue fg:bright-green'` sets bright 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 | | Option | Default | Description |
| ----------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | [link](#default-prompt-format) | Configure the format of the prompt. | | `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). | | `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). | | `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). |
| `add_newline` | `true` | Inserts blank line between shell prompts. | | `add_newline` | `true` | Inserts blank line between shell prompts. |
| `palette` | `''` | Sets which color palette from `palettes` to use. | | `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. | | `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. |
::: tip ::: tip

2
docs/bn-BD/faq/README.md
View File

@ -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? ## 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? ## I see symbols I don't understand or expect, what do they mean?

6
docs/bn-BD/guide/README.md
View File

@ -40,11 +40,11 @@
</p> </p>
<p align="center"> <p align="center">
<a href="https://starship.rs">ওয়েবসাইট</a> <a href="https://starship.rs/bn-BD">ওয়েবসাইট</a>
· ·
<a href="#🚀-installation">ইন্সটল</a> <a href="#🚀-installation">ইন্সটল</a>
· ·
<a href="https://starship.rs/config/"> কনফিগ</a> <a href="https://starship.rs/bn-BD/config/"> কনফিগ</a>
</p> </p>
<p align="center"> <p align="center">
@ -171,7 +171,7 @@
- **সহজ:** অনায়াসে ইন্সটল করুন – মিনিটের মধ্যে ব্যবহার শুরু করে দিন । - **সহজ:** অনায়াসে ইন্সটল করুন – মিনিটের মধ্যে ব্যবহার শুরু করে দিন ।
<p align="center"> <p align="center">
<a href="https://starship.rs/config/"><strong>Starship এর ডকুমেন্টেশন ঘুরে দেখুন&nbsp;&nbsp;▶</strong></a> <a href="https://starship.rs/bn-BD/config/"><strong>Starship এর ডকুমেন্টেশন ঘুরে দেখুন&nbsp;&nbsp;▶</strong></a>
</p> </p>
<a name="🚀-installation"></a> <a name="🚀-installation"></a>

2
docs/bn-BD/installing/README.md
View File

@ -5,7 +5,7 @@ To install starship, you need to do two things:
1. Get the **starship** binary onto your computer 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 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! 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!

4
docs/bn-BD/presets/bracketed-segments.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#bracketed-segments) [Return to Presets](./#bracketed-segments)
# Bracketed Segments Preset # Bracketed Segments Preset
@ -14,4 +14,4 @@ starship preset bracketed-segments -o ~/.config/starship.toml
[Click to download TOML](/presets/toml/bracketed-segments.toml) [Click to download TOML](/presets/toml/bracketed-segments.toml)
<<< @/.vuepress/public/presets/toml/bracketed-segments.toml <<< @/public/presets/toml/bracketed-segments.toml

4
docs/bn-BD/presets/gruvbox-rainbow.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#gruvbox-rainbow) [Return to Presets](./#gruvbox-rainbow)
# Gruvbox Rainbow Preset # Gruvbox Rainbow Preset
@ -18,4 +18,4 @@ starship preset gruvbox-rainbow -o ~/.config/starship.toml
[Click to download TOML](/presets/toml/gruvbox-rainbow.toml) [Click to download TOML](/presets/toml/gruvbox-rainbow.toml)
<<< @/.vuepress/public/presets/toml/gruvbox-rainbow.toml <<< @/public/presets/toml/gruvbox-rainbow.toml

4
docs/bn-BD/presets/jetpack.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#jetpack) [Return to Presets](./#jetpack)
# Jetpack Preset # Jetpack Preset
@ -21,4 +21,4 @@ starship preset jetpack -o ~/.config/starship.toml
[Click to download TOML](/presets/toml/jetpack.toml) [Click to download TOML](/presets/toml/jetpack.toml)
<<< @/.vuepress/public/presets/toml/jetpack.toml <<< @/public/presets/toml/jetpack.toml

4
docs/bn-BD/presets/nerd-font.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#nerd-font-symbols) [Return to Presets](./#nerd-font-symbols)
# Nerd Font Symbols Preset # 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) [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

4
docs/bn-BD/presets/no-empty-icons.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#no-empty-icons) [Return to Presets](./#no-empty-icons)
# No Empty Icons Preset # 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) [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

4
docs/bn-BD/presets/no-nerd-font.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#no-nerd-fonts) [Return to Presets](./#no-nerd-fonts)
# No Nerd Fonts Preset # 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) [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

4
docs/bn-BD/presets/no-runtimes.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#no-runtime-versions) [Return to Presets](./#no-runtime-versions)
# No Runtime Versions Preset # 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) [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

4
docs/bn-BD/presets/pastel-powerline.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#pastel-powerline) [Return to Presets](./#pastel-powerline)
# Pastel Powerline Preset # Pastel Powerline Preset
@ -18,4 +18,4 @@ starship preset pastel-powerline -o ~/.config/starship.toml
[Click to download TOML](/presets/toml/pastel-powerline.toml) [Click to download TOML](/presets/toml/pastel-powerline.toml)
<<< @/.vuepress/public/presets/toml/pastel-powerline.toml <<< @/public/presets/toml/pastel-powerline.toml

4
docs/bn-BD/presets/plain-text.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#plain-text-symbols) [Return to Presets](./#plain-text-symbols)
## Plain Text Symbols Preset ## 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) [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

4
docs/bn-BD/presets/pure-preset.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#pure) [Return to Presets](./#pure)
# Pure Preset # Pure Preset
@ -14,4 +14,4 @@ starship preset pure-preset -o ~/.config/starship.toml
[Click to download TOML](/presets/toml/pure-preset.toml) [Click to download TOML](/presets/toml/pure-preset.toml)
<<< @/.vuepress/public/presets/toml/pure-preset.toml <<< @/public/presets/toml/pure-preset.toml

4
docs/bn-BD/presets/tokyo-night.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#pastel-powerline) [Return to Presets](./#pastel-powerline)
# Tokyo Night Preset # Tokyo Night Preset
@ -18,4 +18,4 @@ starship preset tokyo-night -o ~/.config/starship.toml
[Click to download TOML](/presets/toml/tokyo-night.toml) [Click to download TOML](/presets/toml/tokyo-night.toml)
<<< @/.vuepress/public/presets/toml/tokyo-night.toml <<< @/public/presets/toml/tokyo-night.toml

13
docs/ckb-IR/README.md
View File

@ -1,10 +1,13 @@
--- ---
home: true layout: home
heroImage: /logo.svg hero:
heroText: image: /logo.svg
text: null
tagline: promptـێکی سوکەڵە، خێرا، و بێسنور دڵخوازکراو بۆ هەر شێڵێک! tagline: promptـێکی سوکەڵە، خێرا، و بێسنور دڵخوازکراو بۆ هەر شێڵێک!
actionText: دەستپێبکە ← actions:
actionLink: ./guide/ - theme: brand
text: دەستپێبکە ←
link: ./guide/
features: features:
- -
title: سەرەتا گونجان title: سەرەتا گونجان

2
docs/ckb-IR/advanced-config/README.md
View File

@ -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`. 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. `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell, bash.

6
docs/ckb-IR/config/README.md
View File

@ -158,7 +158,7 @@ In the second part, which is enclosed in a `()`, is a [style string](#style-stri
#### Style Strings #### 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 - `'fg:green bg:blue'` sets green text on a blue background
- `'bg:blue fg:bright-green'` sets bright 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 | | Option | Default | Description |
| ----------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | [link](#default-prompt-format) | Configure the format of the prompt. | | `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). | | `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). | | `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). |
| `add_newline` | `true` | Inserts blank line between shell prompts. | | `add_newline` | `true` | Inserts blank line between shell prompts. |
| `palette` | `''` | Sets which color palette from `palettes` to use. | | `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. | | `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. |
::: tip ::: tip

2
docs/ckb-IR/faq/README.md
View File

@ -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? ## 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? ## I see symbols I don't understand or expect, what do they mean?

4
docs/ckb-IR/guide/README.md
View File

@ -40,7 +40,7 @@
</p> </p>
<p align="center"> <p align="center">
<a href="https://starship.rs">ماڵپەڕ</a> · <a href="#🚀-installation">دامەزراندن</a> · <a href="https://starship.rs/config/">رێکخستن</a> <a href="https://starship.rs/ckb-IR">ماڵپەڕ</a> · <a href="#🚀-installation">دامەزراندن</a> · <a href="https://starship.rs/ckb-IR/config/">رێکخستن</a>
</p> </p>
<p align="center"> <p align="center">
@ -167,7 +167,7 @@
- **ئاسان:** خێرا لە دامەزراندن – دەست ئەکەیت بە بەکارهێنانی لە چەند خولەکێکدا. - **ئاسان:** خێرا لە دامەزراندن – دەست ئەکەیت بە بەکارهێنانی لە چەند خولەکێکدا.
<p align="center"> <p align="center">
<a href="https://starship.rs/config/"><strong>بەڵگەنامەکانی Starship بگەڕێ&nbsp;&nbsp;◀</strong></a> <a href="https://starship.rs/ckb-IR/config/"><strong>بەڵگەنامەکانی Starship بگەڕێ&nbsp;&nbsp;◀</strong></a>
</p> </p>
<a name="🚀-installation"></a> <a name="🚀-installation"></a>

2
docs/ckb-IR/installing/README.md
View File

@ -5,7 +5,7 @@ To install starship, you need to do two things:
1. Get the **starship** binary onto your computer 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 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! 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!

4
docs/ckb-IR/presets/bracketed-segments.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#bracketed-segments) [Return to Presets](./#bracketed-segments)
# Bracketed Segments Preset # Bracketed Segments Preset
@ -14,4 +14,4 @@ starship preset bracketed-segments -o ~/.config/starship.toml
[Click to download TOML](/presets/toml/bracketed-segments.toml) [Click to download TOML](/presets/toml/bracketed-segments.toml)
<<< @/.vuepress/public/presets/toml/bracketed-segments.toml <<< @/public/presets/toml/bracketed-segments.toml

4
docs/ckb-IR/presets/gruvbox-rainbow.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#gruvbox-rainbow) [Return to Presets](./#gruvbox-rainbow)
# Gruvbox Rainbow Preset # Gruvbox Rainbow Preset
@ -18,4 +18,4 @@ starship preset gruvbox-rainbow -o ~/.config/starship.toml
[Click to download TOML](/presets/toml/gruvbox-rainbow.toml) [Click to download TOML](/presets/toml/gruvbox-rainbow.toml)
<<< @/.vuepress/public/presets/toml/gruvbox-rainbow.toml <<< @/public/presets/toml/gruvbox-rainbow.toml

4
docs/ckb-IR/presets/jetpack.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#jetpack) [Return to Presets](./#jetpack)
# Jetpack Preset # Jetpack Preset
@ -21,4 +21,4 @@ starship preset jetpack -o ~/.config/starship.toml
[Click to download TOML](/presets/toml/jetpack.toml) [Click to download TOML](/presets/toml/jetpack.toml)
<<< @/.vuepress/public/presets/toml/jetpack.toml <<< @/public/presets/toml/jetpack.toml

4
docs/ckb-IR/presets/nerd-font.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#nerd-font-symbols) [Return to Presets](./#nerd-font-symbols)
# Nerd Font Symbols Preset # 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) [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

4
docs/ckb-IR/presets/no-empty-icons.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#no-empty-icons) [Return to Presets](./#no-empty-icons)
# No Empty Icons Preset # 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) [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

4
docs/ckb-IR/presets/no-nerd-font.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#no-nerd-fonts) [Return to Presets](./#no-nerd-fonts)
# No Nerd Fonts Preset # 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) [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

4
docs/ckb-IR/presets/no-runtimes.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#no-runtime-versions) [Return to Presets](./#no-runtime-versions)
# No Runtime Versions Preset # 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) [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

4
docs/ckb-IR/presets/pastel-powerline.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#pastel-powerline) [Return to Presets](./#pastel-powerline)
# Pastel Powerline Preset # Pastel Powerline Preset
@ -18,4 +18,4 @@ starship preset pastel-powerline -o ~/.config/starship.toml
[Click to download TOML](/presets/toml/pastel-powerline.toml) [Click to download TOML](/presets/toml/pastel-powerline.toml)
<<< @/.vuepress/public/presets/toml/pastel-powerline.toml <<< @/public/presets/toml/pastel-powerline.toml

4
docs/ckb-IR/presets/plain-text.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#plain-text-symbols) [Return to Presets](./#plain-text-symbols)
## Plain Text Symbols Preset ## 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) [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

4
docs/ckb-IR/presets/pure-preset.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#pure) [Return to Presets](./#pure)
# Pure Preset # Pure Preset
@ -14,4 +14,4 @@ starship preset pure-preset -o ~/.config/starship.toml
[Click to download TOML](/presets/toml/pure-preset.toml) [Click to download TOML](/presets/toml/pure-preset.toml)
<<< @/.vuepress/public/presets/toml/pure-preset.toml <<< @/public/presets/toml/pure-preset.toml

4
docs/ckb-IR/presets/tokyo-night.md
View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#pastel-powerline) [Return to Presets](./#pastel-powerline)
# Tokyo Night Preset # Tokyo Night Preset
@ -18,4 +18,4 @@ starship preset tokyo-night -o ~/.config/starship.toml
[Click to download TOML](/presets/toml/tokyo-night.toml) [Click to download TOML](/presets/toml/tokyo-night.toml)
<<< @/.vuepress/public/presets/toml/tokyo-night.toml <<< @/public/presets/toml/tokyo-night.toml

8
docs/config/README.md
View File

@ -164,7 +164,7 @@ For example:
#### Style Strings #### 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 - `'fg:green bg:blue'` sets green text on a blue background
- `'bg:blue fg:bright-green'` sets bright green text on a blue background - `'bg:blue fg:bright-green'` sets bright green text on a blue background
@ -211,14 +211,14 @@ This is the list of prompt-wide configuration options.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ----------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------- | ------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | [link](#default-prompt-format) | Configure the format of the prompt. | | `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). | | `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
| `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). | | `command_timeout` | `500` | Timeout for commands executed by starship (in milliseconds). |
| `add_newline` | `true` | Inserts blank line between shell prompts. | | `add_newline` | `true` | Inserts blank line between shell prompts. |
| `palette` | `''` | Sets which color palette from `palettes` to use. | | `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. | | `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. |
::: tip ::: tip

13
docs/de-DE/README.md
View File

@ -1,10 +1,13 @@
--- ---
home: true layout: home
heroImage: /logo.svg hero:
heroText: image: /logo.svg
text: null
tagline: Minimale, super schnelle und unendlich anpassbare Prompt für jede Shell! tagline: Minimale, super schnelle und unendlich anpassbare Prompt für jede Shell!
actionText: Loslegen → actions:
actionLink: ./de-DE/guide/ - theme: brand
text: Loslegen →
link: ./guide/
features: features:
- -
title: Kompatibel title: Kompatibel

2
docs/de-DE/advanced-config/README.md
View File

@ -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`. 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. `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell, bash.

6
docs/de-DE/config/README.md
View File

@ -159,7 +159,7 @@ Hier sind ein paar Beispiele:
#### Style-Strings #### Style-Strings
Die meisten Module in Starship lassen dich den Darstellungsstil verändern. Dies passiert meistens an einem bestimmten Eintrag (gewöhnlich `style` genannt), der einen String mit den Einstellungen darstellt. Es folgen ein paar Beispiele für solche Strings zusammen der mit Beschreibungen, was sie bewirken. Details zur vollen Syntax findest du im [Erweiterten Konfigurationshandbuch](/advanced-config/). Die meisten Module in Starship lassen dich den Darstellungsstil verändern. Dies passiert meistens an einem bestimmten Eintrag (gewöhnlich `style` genannt), der einen String mit den Einstellungen darstellt. Es folgen ein paar Beispiele für solche Strings zusammen der mit Beschreibungen, was sie bewirken. Details zur vollen Syntax findest du im [Erweiterten Konfigurationshandbuch](../advanced-config/).
- `'fg:green bg:blue'` sets green text on a blue background - `'fg:green bg:blue'` sets green text on a blue background
- `'bg:blue fg:bright-green'` sets bright green text on a blue background - `'bg:blue fg:bright-green'` sets bright green text on a blue background
@ -201,12 +201,12 @@ Dies ist eine Liste mit Prompt-weiten Konfigurationsoptionen.
| Option | Standartwert | Beschreibung | | Option | Standartwert | Beschreibung |
| ----------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | [link](#default-prompt-format) | Das Aussehen des Prompts festlegen. | | `format` | [link](#default-prompt-format) | Das Aussehen des Prompts festlegen. |
| `right_format` | `''` | Sieh [Enable Right Prompt](/advanced-config/#enable-right-prompt) | | `right_format` | `''` | Sieh [Enable Right Prompt](../advanced-config/#enable-right-prompt) |
| `scan_timeout` | `30` | Timeout für das Scannen von Dateien (in Millisekunden). | | `scan_timeout` | `30` | Timeout für das Scannen von Dateien (in Millisekunden). |
| `command_timeout` | `500` | Maximale Zeit für von Starship ausgeführte Kommandos. | | `command_timeout` | `500` | Maximale Zeit für von Starship ausgeführte Kommandos. |
| `add_newline` | `true` | Fügt leere Zeilen zwischen Shell Prompts ein. | | `add_newline` | `true` | Fügt leere Zeilen zwischen Shell Prompts ein. |
| `palette` | `''` | Sets which color palette from `palettes` to use. | | `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. | | `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. |
::: tip ::: tip

2
docs/de-DE/faq/README.md
View File

@ -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? ## 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? ## I see symbols I don't understand or expect, what do they mean?

6
docs/de-DE/guide/README.md
View File

@ -40,11 +40,11 @@
</p> </p>
<p align="center"> <p align="center">
<a href="https://starship.rs">Website</a> <a href="https://starship.rs/de-DE">Website</a>
· ·
<a href="#🚀-installation">Installation</a> <a href="#🚀-installation">Installation</a>
· ·
<a href="https://starship.rs/config/">Konfiguration</a> <a href="https://starship.rs/de-DE/config/">Konfiguration</a>
</p> </p>
<p align="center"> <p align="center">
@ -171,7 +171,7 @@
- **Einfach:** schnell zu installieren – Betriebsbereit in nur wenigen Minuten. - **Einfach:** schnell zu installieren – Betriebsbereit in nur wenigen Minuten.
<p align="center"> <p align="center">
<a href="https://starship.rs/config/"><strong>Schau dir die Starship-Dokumentation an&nbsp;&nbsp;▶</strong></a> <a href="https://starship.rs/de-DE/config/"><strong>Schau dir die Starship-Dokumentation an&nbsp;&nbsp;▶</strong></a>
</p> </p>
<a name="🚀-installation"></a> <a name="🚀-installation"></a>

2
docs/de-DE/installing/README.md
View File

@ -5,7 +5,7 @@ Um Starship zu installieren, musst du zwei Dinge tun:
1. Lade die **starship** Datei auf den Computer herunter 1. Lade die **starship** Datei auf den Computer herunter
1. Weise deine Shell an die Starship Datei als Eingabeaufforderung zu nutzen, indem du eines der Initialisierungs-Skripte benutzt 1. Weise deine Shell an die Starship Datei als Eingabeaufforderung zu nutzen, indem du eines der Initialisierungs-Skripte benutzt
Die Anleitung auf [der Hauptseite](/guide/#🚀-installation) wird für die meisten Benutzer ausreichend sein. Für einige speziellere Plattformen wird jedoch eine speziellere Anleitung benötigt. Die Anleitung auf [der Hauptseite](../guide/#🚀-installation) wird für die meisten Benutzer ausreichend sein. Für einige speziellere Plattformen wird jedoch eine speziellere Anleitung benötigt.
Es gibt sehr viele Plattformen, sodass diese nicht alle in die Hauptanleitung passen, aus diesem Grund sind hier ein paar Installationsanweisungen für ein paar Plattformen von der Community. Ist deine Platform nicht dabei? Dann füge bitte deine hinzu, sobald du herausgefunden hast wie man starship mit dieser benutzt! Es gibt sehr viele Plattformen, sodass diese nicht alle in die Hauptanleitung passen, aus diesem Grund sind hier ein paar Installationsanweisungen für ein paar Plattformen von der Community. Ist deine Platform nicht dabei? Dann füge bitte deine hinzu, sobald du herausgefunden hast wie man starship mit dieser benutzt!

4
docs/de-DE/presets/bracketed-segments.md
View File

@ -1,4 +1,4 @@
[Zurück zu den Voreinstellungen](./README.md#bracketed-segments) [Zurück zu den Voreinstellungen](./#bracketed-segments)
# Bracketed Segments Preset # Bracketed Segments Preset
@ -14,4 +14,4 @@ starship preset bracketed-segments -o ~/.config/starship.toml
[Zum Herunterladen der TOML Datei klicken](/presets/toml/bracketed-segments.toml) [Zum Herunterladen der TOML Datei klicken](/presets/toml/bracketed-segments.toml)
<<< @/.vuepress/public/presets/toml/bracketed-segments.toml <<< @/public/presets/toml/bracketed-segments.toml

4
docs/de-DE/presets/gruvbox-rainbow.md
View File

@ -1,4 +1,4 @@
[Zurück zu den Voreinstellungen](./README.md#gruvbox-rainbow) [Zurück zu den Voreinstellungen](./#gruvbox-rainbow)
# Gruvbox Regenbogen # Gruvbox Regenbogen
@ -18,4 +18,4 @@ starship preset gruvbox-rainbow -o ~/.config/starship.toml
[Zum Herunterladen der TOML Datei klicken](/presets/toml/gruvbox-rainbow.toml) [Zum Herunterladen der TOML Datei klicken](/presets/toml/gruvbox-rainbow.toml)
<<< @/.vuepress/public/presets/toml/gruvbox-rainbow.toml <<< @/public/presets/toml/gruvbox-rainbow.toml

4
docs/de-DE/presets/jetpack.md
View File

@ -1,4 +1,4 @@
[Zurück zu den Voreinstellungen](./README.md#jetpack) [Zurück zu den Voreinstellungen](./#jetpack)
# Jetpack Preset # Jetpack Preset
@ -21,4 +21,4 @@ starship preset jetpack -o ~/.config/starship.toml
[Zum Herunterladen der TOML Datei klicken](/presets/toml/jetpack.toml) [Zum Herunterladen der TOML Datei klicken](/presets/toml/jetpack.toml)
<<< @/.vuepress/public/presets/toml/jetpack.toml <<< @/public/presets/toml/jetpack.toml

4
docs/de-DE/presets/nerd-font.md
View File

@ -1,4 +1,4 @@
[Zurück zu den Voreinstellungen](./README.md#nerd-font-symbols) [Zurück zu den Voreinstellungen](./#nerd-font-symbols)
# Nerd Font Symbols Preset # Nerd Font Symbols Preset
@ -18,4 +18,4 @@ starship preset nerd-font-symbols -o ~/.config/starship.toml
[Zum Herunterladen der TOML Datei klicken](/presets/toml/nerd-font-symbols.toml) [Zum Herunterladen der TOML Datei klicken](/presets/toml/nerd-font-symbols.toml)
<<< @/.vuepress/public/presets/toml/nerd-font-symbols.toml <<< @/public/presets/toml/nerd-font-symbols.toml

4
docs/de-DE/presets/no-empty-icons.md
View File

@ -1,4 +1,4 @@
[Zurück zu den Voreinstellungen](./README.md#no-empty-icons) [Zurück zu den Voreinstellungen](./#no-empty-icons)
# No Empty Icons Preset # No Empty Icons Preset
@ -14,4 +14,4 @@ starship preset no-empty-icons -o ~/.config/starship.toml
[Zum Herunterladen der TOML Datei klicken](/presets/toml/no-empty-icons.toml) [Zum Herunterladen der TOML Datei klicken](/presets/toml/no-empty-icons.toml)
<<< @/.vuepress/public/presets/toml/no-empty-icons.toml <<< @/public/presets/toml/no-empty-icons.toml

4
docs/de-DE/presets/no-nerd-font.md
View File

@ -1,4 +1,4 @@
[Zurück zu den Voreinstellungen](./README.md#no-nerd-fonts) [Zurück zu den Voreinstellungen](./#no-nerd-fonts)
# No Nerd Fonts Preset # No Nerd Fonts Preset
@ -16,4 +16,4 @@ starship preset no-nerd-font -o ~/.config/starship.toml
[Zum Herunterladen der TOML Datei klicken](/presets/toml/no-nerd-font.toml) [Zum Herunterladen der TOML Datei klicken](/presets/toml/no-nerd-font.toml)
<<< @/.vuepress/public/presets/toml/no-nerd-font.toml <<< @/public/presets/toml/no-nerd-font.toml

4
docs/de-DE/presets/no-runtimes.md
View File

@ -1,4 +1,4 @@
[Zurück zu den Voreinstellungen](./README.md#no-runtime-versions) [Zurück zu den Voreinstellungen](./#no-runtime-versions)
# No Runtime Versions Preset # No Runtime Versions Preset
@ -14,4 +14,4 @@ starship preset no-runtime-versions -o ~/.config/starship.toml
[Zum Herunterladen der TOML Datei klicken](/presets/toml/no-runtime-versions.toml) [Zum Herunterladen der TOML Datei klicken](/presets/toml/no-runtime-versions.toml)
<<< @/.vuepress/public/presets/toml/no-runtime-versions.toml <<< @/public/presets/toml/no-runtime-versions.toml

4
docs/de-DE/presets/pastel-powerline.md
View File

@ -1,4 +1,4 @@
[Zurück zu den Voreinstellungen](./README.md#pastel-powerline) [Zurück zu den Voreinstellungen](./#pastel-powerline)
# Pastel Powerline Preset # Pastel Powerline Preset
@ -18,4 +18,4 @@ starship preset pastel-powerline -o ~/.config/starship.toml
[Zum Herunterladen der TOML Datei klicken](/presets/toml/pastel-powerline.toml) [Zum Herunterladen der TOML Datei klicken](/presets/toml/pastel-powerline.toml)
<<< @/.vuepress/public/presets/toml/pastel-powerline.toml <<< @/public/presets/toml/pastel-powerline.toml

4
docs/de-DE/presets/plain-text.md
View File

@ -1,4 +1,4 @@
[Zurück zu den Voreinstellungen](./README.md#plain-text-symbols) [Zurück zu den Voreinstellungen](./#plain-text-symbols)
## Plain Text Symbols Preset ## Plain Text Symbols Preset
@ -14,4 +14,4 @@ starship preset plain-text-symbols -o ~/.config/starship.toml
[Zum Herunterladen der TOML Datei klicken](/presets/toml/plain-text-symbols.toml) [Zum Herunterladen der TOML Datei klicken](/presets/toml/plain-text-symbols.toml)
<<< @/.vuepress/public/presets/toml/plain-text-symbols.toml <<< @/public/presets/toml/plain-text-symbols.toml

4
docs/de-DE/presets/pure-preset.md
View File

@ -1,4 +1,4 @@
[Zurück zu den Voreinstellungen](./README.md#pure) [Zurück zu den Voreinstellungen](./#pure)
# Pure Voreinstellung # Pure Voreinstellung
@ -14,4 +14,4 @@ starship preset pure-preset -o ~/.config/starship.toml
[Zum Herunterladen der TOML Datei klicken](/presets/toml/pure-preset.toml) [Zum Herunterladen der TOML Datei klicken](/presets/toml/pure-preset.toml)
<<< @/.vuepress/public/presets/toml/pure-preset.toml <<< @/public/presets/toml/pure-preset.toml

4
docs/de-DE/presets/tokyo-night.md
View File

@ -1,4 +1,4 @@
[Zurück zu den Voreinstellungen](./README.md#pastel-powerline) [Zurück zu den Voreinstellungen](./#pastel-powerline)
# Tokyo Night Preset # Tokyo Night Preset
@ -18,4 +18,4 @@ starship preset tokyo-night -o ~/.config/starship.toml
[Zum Herunterladen der TOML Datei klicken](/presets/toml/tokyo-night.toml) [Zum Herunterladen der TOML Datei klicken](/presets/toml/tokyo-night.toml)
<<< @/.vuepress/public/presets/toml/tokyo-night.toml <<< @/public/presets/toml/tokyo-night.toml

13
docs/es-ES/README.md
View File

@ -1,10 +1,13 @@
--- ---
home: true layout: home
heroImage: /logo.svg hero:
heroText: image: /logo.svg
text: null
tagline: '¡El prompt minimalista, ultrarápido e infinitamente personalizable para cualquier intérprete de comandos!' tagline: '¡El prompt minimalista, ultrarápido e infinitamente personalizable para cualquier intérprete de comandos!'
actionText: Comenzar → actions:
actionLink: ./guide/ - theme: brand
text: Comenzar →
link: ./guide/
features: features:
- -
title: Compatibilidad primero title: Compatibilidad primero

2
docs/es-ES/advanced-config/README.md
View File

@ -223,7 +223,7 @@ Invoke-Expression (&starship init powershell)
Algunos intérpretes de comandos soportan un prompt derecho que se renderiza en la misma línea que la entrada. Starship puede establecer el contenido del prompt derecho usando la opción `right_format`. Cualquier módulo que pueda ser usado en `format` también es soportado en `right_format`. La variable `$all` solo contendrá módulos no utilizados explícitamente en `format` o `right_format`. Algunos intérpretes de comandos soportan un prompt derecho que se renderiza en la misma línea que la entrada. Starship puede establecer el contenido del prompt derecho usando la opción `right_format`. Cualquier módulo que pueda ser usado en `format` también es soportado en `right_format`. La variable `$all` solo contendrá módulos no utilizados explícitamente en `format` o `right_format`.
Nota: El prompt derecho es una sola línea siguiendo la ubicación de entrada. Para alinear los módulos arriba de la línea de entrada en un prompt multi-línea, vea el [módulo `fill`](/config/#fill). Nota: El prompt derecho es una sola línea siguiendo la ubicación de entrada. Para alinear los módulos arriba de la línea de entrada en un prompt multi-línea, vea el [módulo `fill`](../config/#fill).
`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell, bash. `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell, bash.

30
docs/es-ES/config/README.md
View File

@ -158,7 +158,7 @@ Por ejemplo:
#### Cadenas de Estilo #### Cadenas de Estilo
La mayoría de los módulos de starship permiten configurar sus estilos de visualización. Esto se consigue con una entrada (normalmente llamada `style`) que no es más que un texto donde se especifica la configuración. A continuación mostramos algunos ejemplos de cadenas de estilo junto con su funcionalidad. Para más detalles sobre la sintaxis completa, consultar [la guía de configuración avanzada](/advanced-config/). La mayoría de los módulos de starship permiten configurar sus estilos de visualización. Esto se consigue con una entrada (normalmente llamada `style`) que no es más que un texto donde se especifica la configuración. A continuación mostramos algunos ejemplos de cadenas de estilo junto con su funcionalidad. Para más detalles sobre la sintaxis completa, consultar [la guía de configuración avanzada](../advanced-config/).
- `'fg:green bg:blue'` define el texto con color verde y el color de fondo azul - `'fg:green bg:blue'` define el texto con color verde y el color de fondo azul
- `'bg:blue fg:bright-green'` sets bright green text on a blue background - `'bg:blue fg:bright-green'` sets bright green text on a blue background
@ -200,12 +200,12 @@ Esta es la lista de opciones de configuración del prompt.
| Opción | Predeterminado | Descripción | | Opción | Predeterminado | Descripción |
| ----------------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | [ver aquí](#default-prompt-format) | Configura el formato del prompt. | | `format` | [ver aquí](#default-prompt-format) | Configura el formato del prompt. |
| `right_format` | `''` | Ver [Habilitar prompt derecho](/advanced-config/#enable-right-prompt) | | `right_format` | `''` | Ver [Habilitar prompt derecho](../advanced-config/#enable-right-prompt) |
| `scan_timeout` | `30` | Tiempo de espera tras el que Starship escanea archivos (en milisegundos). | | `scan_timeout` | `30` | Tiempo de espera tras el que Starship escanea archivos (en milisegundos). |
| `command_timeout` | `500` | Tiempo de espera para los comandos ejecutados por Starship (en milisegundos). | | `command_timeout` | `500` | Tiempo de espera para los comandos ejecutados por Starship (en milisegundos). |
| `add_newline` | `true` | Inserta un línea en blanco entre las instrucciones del intérprete de comandos. | | `add_newline` | `true` | Inserta un línea en blanco entre las instrucciones del intérprete de comandos. |
| `paleta` | `''` | Establece la paleta de color de `paletas` a utilizar. | | `paleta` | `''` | Establece la paleta de color de `paletas` a utilizar. |
| `paletas` | `{}` | Colección de paletas de colores que asignan [colores](/advanced-config/#style-strings) a nombres definidos por el usuario. Tenga en cuenta que las paletas de colores no pueden hacer referencia a sus propias definiciones de color. | | `paletas` | `{}` | Colección de paletas de colores que asignan [colores](../advanced-config/#style-strings) a nombres definidos por el usuario. Tenga en cuenta que las paletas de colores no pueden hacer referencia a sus propias definiciones de color. |
| `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. | | `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. |
::: tip ::: tip
@ -529,7 +529,7 @@ La opción `display` es un arreglo de la siguiente tabla.
| Opción | Predeterminado | Descripción | | Opción | Predeterminado | Descripción |
| -------------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------- | | -------------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `threshold` | `10` | El umbral para la opción de visualización. | | `threshold` | `10` | El umbral para la opción de visualización. |
| `style` | `'red bold'` | El estilo usado cuando si la opción <0>display</0> está activa. | | `style` | `'red bold'` | El estilo usado cuando si la opción `display` está activa. |
| `charging_symbol` | | Símbolo opcional que se muestra si la opción de visualización está en uso, por defecto en la opción `charging_symbol` de la batería. | | `charging_symbol` | | Símbolo opcional que se muestra si la opción de visualización está en uso, por defecto en la opción `charging_symbol` de la batería. |
| `discharging_symbol` | | Símbolo opcional que se muestra si la opción de visualización está en uso, por defecto en la opción `discharging_symbol` de la batería. | | `discharging_symbol` | | Símbolo opcional que se muestra si la opción de visualización está en uso, por defecto en la opción `discharging_symbol` de la batería. |
@ -2204,25 +2204,13 @@ El módulo `hostname` muestra el nombre de host del sistema.
| `detect_env_vars` | `[]` | Qué variable(s) de entorno deben activar este módulo. | | `detect_env_vars` | `[]` | Qué variable(s) de entorno deben activar este módulo. |
| `format` | `'[$ssh_symbol$hostname]($style) in '` | El formato del módulo. | | `format` | `'[$ssh_symbol$hostname]($style) in '` | El formato del módulo. |
| `style` | `'negrita oscurecida verde'` | El estilo del módulo. | | `style` | `'negrita oscurecida verde'` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `hostname<0>.</td> | `disabled` | `false` | Deshabilita el módulo `hostname`. |
</tr>
</tbody>
</table>
<h3 spaces-before="0">Variables</h3>
<table spaces-before="0"> ### Variables
<thead>
<tr> | Variable | Ejemplo | Descripción |
<th>Variable</th> | nombre del host | `computadora` | El nombre de host de la computadora |
<th>Ejemplo</th>
<th>Descripción</th>
</tr>
</thead>
<tbody>
<tr>
<td>nombre del host</td>
<td><code>computadora` | El nombre de host de la computadora |
| style\* | | Refleja el valor de la opción `style` | | style\* | | Refleja el valor de la opción `style` |
| ssh_symbol | `'🌏 '` | El símbolo a representar cuando está conectado a la sesión SSH | | ssh_symbol | `'🌏 '` | El símbolo a representar cuando está conectado a la sesión SSH |

2
docs/es-ES/faq/README.md
View File

@ -58,7 +58,7 @@ curl -sS https://starship.rs/install.sh | sh -s -- --platform unknown-linux-musl
## ¿Por qué veo advertencias `Executing command"..." timed out.`? ## ¿Por qué veo advertencias `Executing command"..." timed out.`?
Starship ejecuta diferentes comandos para obtener la información que se muestra en el prompt, por ejemplo la versión de un programa o el estado actual de git. Para asegurarse que starship no se quede congelado mientras trata de ejecutar estos comandos, establecimos un límite de tiempo, si un comando tarda más tiempo que este límite starship detendrá la ejecución del comando y mostrara la advertencia anterior, este es el comportamiento esperado. Este límite de tiempo es configurable usando la [llave `command_timeout`](/config/#prompt) así que si lo desea puede aumentar el límite de tiempo. También puedes seguir los pasos de depuración a continuación para ver qué comando está siendo lento y ver si puedes optimizarlo. Finalmente, puedes establecer la variable de entorno `STARSHIP_LOG` a `error` para ocultar estas advertencias. Starship ejecuta diferentes comandos para obtener la información que se muestra en el prompt, por ejemplo la versión de un programa o el estado actual de git. Para asegurarse que starship no se quede congelado mientras trata de ejecutar estos comandos, establecimos un límite de tiempo, si un comando tarda más tiempo que este límite starship detendrá la ejecución del comando y mostrara la advertencia anterior, este es el comportamiento esperado. Este límite de tiempo es configurable usando la [llave `command_timeout`](../config/#prompt) así que si lo desea puede aumentar el límite de tiempo. También puedes seguir los pasos de depuración a continuación para ver qué comando está siendo lento y ver si puedes optimizarlo. Finalmente, puedes establecer la variable de entorno `STARSHIP_LOG` a `error` para ocultar estas advertencias.
## Veo símbolos que no entiendo ni espero, ¿qué significan? ## Veo símbolos que no entiendo ni espero, ¿qué significan?

6
docs/es-ES/guide/README.md
View File

@ -40,11 +40,11 @@
</p> </p>
<p align="center"> <p align="center">
<a href="https://starship.rs">Sitio web</a> <a href="https://starship.rs/es-ES">Sitio web</a>
<a href="#🚀-installation">Instalación</a> <a href="#🚀-installation">Instalación</a>
<a href="https://starship.rs/config/">Configuración</a> <a href="https://starship.rs/es-ES/config/">Configuración</a>
</p> </p>
<p align="center"> <p align="center">
@ -171,7 +171,7 @@
- **Fácil:** rápido de instalar – empieza a usarlo en minutos. - **Fácil:** rápido de instalar – empieza a usarlo en minutos.
<p align="center"> <p align="center">
<a href="https://starship.rs/config/"><strong>Explora la documentación de Starship&nbsp;&nbsp;▶</strong></a> <a href="https://starship.rs/es-ES/config/"><strong>Explora la documentación de Starship&nbsp;&nbsp;▶</strong></a>
</p> </p>
<a name="🚀-installation"></a> <a name="🚀-installation"></a>

2
docs/es-ES/installing/README.md
View File

@ -5,7 +5,7 @@ Para instalar Starship, necesitas hacer dos cosas:
1. Consigue el binario de **Starship** en tu ordenador 1. Consigue el binario de **Starship** en tu ordenador
1. Decirle a tu intérprete de comandos que use el binario de Starship como su prompt modificando sus guiones de inicio 1. Decirle a tu intérprete de comandos que use el binario de Starship como su prompt modificando sus guiones de inicio
Para la mayoría de los usuarios, las instrucciones en [la página principal](/guide/#🚀-installation) funcionarán genial. Sin embargo, para algunas plataformas más especializadas, se necesitan diferentes instrucciones. Para la mayoría de los usuarios, las instrucciones en [la página principal](../guide/#🚀-installation) funcionarán genial. Sin embargo, para algunas plataformas más especializadas, se necesitan diferentes instrucciones.
Hay tantas plataformas ahí fuera que no cabían en el README.md principal, así que aquí están algunas instrucciones de instalación para otras plataformas de la comunidad. ¿No está usted aquí? ¡Por favor, añádelo aquí si lo encuentras! Hay tantas plataformas ahí fuera que no cabían en el README.md principal, así que aquí están algunas instrucciones de instalación para otras plataformas de la comunidad. ¿No está usted aquí? ¡Por favor, añádelo aquí si lo encuentras!

4
docs/es-ES/presets/bracketed-segments.md
View File

@ -1,4 +1,4 @@
[Volver a Preajustes](./README.md#bracketed-segments) [Volver a Preajustes](./#bracketed-segments)
# Preajuste Segmentos entre Corchetes # Preajuste Segmentos entre Corchetes
@ -14,4 +14,4 @@ starship preset bracketed-segments -o ~/.config/starship.toml
[Clic para descargar TOML](/presets/toml/bracketed-segments.toml) [Clic para descargar TOML](/presets/toml/bracketed-segments.toml)
<<< @/.vuepress/public/presets/toml/bracketed-segments.toml <<< @/public/presets/toml/bracketed-segments.toml

4
docs/es-ES/presets/gruvbox-rainbow.md
View File

@ -1,4 +1,4 @@
[Volver a Preajustes](./README.md#gruvbox-rainbow) [Volver a Preajustes](./#gruvbox-rainbow)
# Preselección Gruvbox Rainbow # Preselección Gruvbox Rainbow
@ -18,4 +18,4 @@ starship preset gruvbox-rainbow -o ~/.config/starship.toml
[Clic para descargar TOML](/presets/toml/gruvbox-rainbow.toml) [Clic para descargar TOML](/presets/toml/gruvbox-rainbow.toml)
<<< @/.vuepress/public/presets/toml/gruvbox-rainbow.toml <<< @/public/presets/toml/gruvbox-rainbow.toml

4
docs/es-ES/presets/jetpack.md
View File

@ -1,4 +1,4 @@
[Volver a Preajustes](./README.md#jetpack) [Volver a Preajustes](./#jetpack)
# Preajust Jetpack # Preajust Jetpack
@ -21,4 +21,4 @@ starship preset jetpack -o ~/.config/starship.toml
[Clic para descargar TOML](/presets/toml/jetpack.toml) [Clic para descargar TOML](/presets/toml/jetpack.toml)
<<< @/.vuepress/public/presets/toml/jetpack.toml <<< @/public/presets/toml/jetpack.toml

4
docs/es-ES/presets/nerd-font.md
View File

@ -1,4 +1,4 @@
[Volver a Preajustes](./README.md#nerd-font-symbols) [Volver a Preajustes](./#nerd-font-symbols)
# Preajuste de Símbolos de Nerd Font # Preajuste de Símbolos de Nerd Font
@ -18,4 +18,4 @@ starship preset nerd-font-symbols -o ~/.config/starship.toml
[Clic para descargar TOML](/presets/toml/nerd-font-symbols.toml) [Clic para descargar TOML](/presets/toml/nerd-font-symbols.toml)
<<< @/.vuepress/public/presets/toml/nerd-font-symbols.toml <<< @/public/presets/toml/nerd-font-symbols.toml

4
docs/es-ES/presets/no-empty-icons.md
View File

@ -1,4 +1,4 @@
[Volver a las preselecciones](./README.md#no-empty-icons) [Volver a las preselecciones](./#no-empty-icons)
# Preselección de iconos no vacíos # Preselección de iconos no vacíos
@ -14,4 +14,4 @@ starship preset no-empty-icons -o ~/.config/starship.toml
[Clic para descargar TOML](/presets/toml/no-empty-icons.toml) [Clic para descargar TOML](/presets/toml/no-empty-icons.toml)
<<< @/.vuepress/public/presets/toml/no-empty-icons.toml <<< @/public/presets/toml/no-empty-icons.toml

4
docs/es-ES/presets/no-nerd-font.md
View File

@ -1,4 +1,4 @@
[Volver a Preajustes](./README.md#no-nerd-fonts) [Volver a Preajustes](./#no-nerd-fonts)
# No Nerd Fonts Preset # No Nerd Fonts Preset
@ -16,4 +16,4 @@ starship preset no-nerd-font -o ~/.config/starship.toml
[Clic para descargar TOML](/presets/toml/no-nerd-font.toml) [Clic para descargar TOML](/presets/toml/no-nerd-font.toml)
<<< @/.vuepress/public/presets/toml/no-nerd-font.toml <<< @/public/presets/toml/no-nerd-font.toml

Some files were not shown because too many files have changed in this diff Show More