mirror of
https://github.com/starship/starship.git
synced 2026-06-23 02:05:51 +07:00
feat(docs): move to vitepress (#5785)
* feat(docs): move to vitepress * change up hero styles to match existing site * A bit more style tweaking * Replace stylus with plain CSS * improve unicode-range value for nerdfont --------- Co-authored-by: Matan Kushner <hello@matchai.dev>
This commit is contained in:
David Knaack
+12
-9
@@ -1,18 +1,21 @@
|
||||
---
|
||||
home: true
|
||||
heroImage: /logo.svg
|
||||
heroText:
|
||||
tagline: シェル用の最小限の、非常に高速で、無限にカスタマイズ可能なプロンプトです！
|
||||
actionText: Get Started →
|
||||
actionLink: ./guide/
|
||||
layout: home
|
||||
hero:
|
||||
image: /logo.svg
|
||||
text: null
|
||||
tagline: シェル用の最小限の、非常に高速で、無限にカスタマイズ可能なプロンプトです！
|
||||
actions:
|
||||
- theme: brand
|
||||
text: Get Started →
|
||||
link: ./guide/
|
||||
features:
|
||||
-
|
||||
-
|
||||
title: 互換性優先
|
||||
details: 一般的なほとんどのOSの一般的なほとんどのシェル上で動作します。 あらゆるところで使用してください！
|
||||
-
|
||||
-
|
||||
title: Rust製
|
||||
details: Rustの最高レベルの速度と安全性を用いることで、可能な限り高速かつ信頼性を高くしています。
|
||||
-
|
||||
-
|
||||
title: カスタマイズ可能
|
||||
details: それぞれの細かい点は好みにカスタマイズが出来るため、ミニマルにも多機能にも好きなようにプロンプトを設定することができます。
|
||||
footer: ISC Licensed | Copyright © 2019-present Starship Contributors
|
||||
|
||||
@@ -223,7 +223,7 @@ Invoke-Expression (&starship init powershell)
|
||||
|
||||
シェルによっては、入力と同じ行にレンダリングされる右プロンプトをサポートしています。 Starship では `right_format` オプションを使って右プロンプトの内容を設定できます。 `format`で使用できるモジュールはすべて`right_format`でも使用できます。 変数`$all`には、`format`や`right_format`で明示的に使用されていないモジュールのみが格納されます。
|
||||
|
||||
注意: 右プロンプトは入力の場所に続く単一の行です。 To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill).
|
||||
注意: 右プロンプトは入力の場所に続く単一の行です。 To right align modules above the input line in a multi-line prompt, see the [`fill` module](../config/#fill).
|
||||
|
||||
`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell, bash.
|
||||
|
||||
|
||||
@@ -158,7 +158,7 @@ line2
|
||||
|
||||
#### スタイルの設定
|
||||
|
||||
Starshipのほとんどのモジュールでは、表示スタイルを設定できます。 これは、設定を指定する文字列であるエントリ（`style`）で行われます。 スタイル文字列の例とその機能を次に示します。 完全な構文の詳細については、詳細は [高度な設定](/advanced-config/)を参照してください 。
|
||||
Starshipのほとんどのモジュールでは、表示スタイルを設定できます。 これは、設定を指定する文字列であるエントリ（`style`）で行われます。 スタイル文字列の例とその機能を次に示します。 完全な構文の詳細については、詳細は [高度な設定](../advanced-config/)を参照してください 。
|
||||
|
||||
- `'fg:green bg:blue'` sets green text on a blue background
|
||||
- `'bg:blue fg:bright-green'` sets bright green text on a blue background
|
||||
@@ -200,12 +200,12 @@ detect_extensions = ['ts', '!video.ts', '!audio.ts']
|
||||
| オプション | デフォルト | 説明 |
|
||||
| ----------------- | ------------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
||||
| `format` | [link](#default-prompt-format) | プロンプトの形式を設定します。 |
|
||||
| `right_format` | `''` | [右プロンプトの有効化](/advanced-config/#enable-right-prompt)を参照してください。 |
|
||||
| `right_format` | `''` | [右プロンプトの有効化](../advanced-config/#enable-right-prompt)を参照してください。 |
|
||||
| `scan_timeout` | `30` | ファイルをスキャンする際のタイムアウト時間 (milliseconds) です。 |
|
||||
| `command_timeout` | `500` | Starshipによって実行されたコマンドのタイムアウト時間 (milliseconds) です。 |
|
||||
| `add_newline` | `true` | シェルプロンプトの間に空行を挿入します。 |
|
||||
| `palette` | `''` | Sets which color palette from `palettes` to use. |
|
||||
| `palettes` | `{}` | Collection of color palettes that assign [colors](/advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. |
|
||||
| `palettes` | `{}` | Collection of color palettes that assign [colors](../advanced-config/#style-strings) to user-defined names. Note that color palettes cannot reference their own color definitions. |
|
||||
| `follow_symlinks` | `true` | Follows symlinks to check if they're directories; used in modules such as git. |
|
||||
|
||||
::: tip
|
||||
|
||||
@@ -58,7 +58,7 @@ curl -sS https://starship.rs/install.sh | sh -s -- --platform unknown-linux-musl
|
||||
|
||||
## どうして`Executing command "..." timed out.`という警告が出てくるのでしょうか?
|
||||
|
||||
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.
|
||||
|
||||
## よくわからない記号を見つけました。これはどういった意味ですか？
|
||||
|
||||
|
||||
@@ -40,11 +40,11 @@
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://starship.rs">ウェブサイト</a>
|
||||
<a href="https://starship.rs/ja-JP">ウェブサイト</a>
|
||||
·
|
||||
<a href="#🚀-installation">インストール</a>
|
||||
·
|
||||
<a href="https://starship.rs/config/">設定</a>
|
||||
<a href="https://starship.rs/ja-JP/config/">設定</a>
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
@@ -171,7 +171,7 @@
|
||||
- **簡単:** 迅速なインストールが可能であり、数分で使用開始可能です。
|
||||
|
||||
<p align="center">
|
||||
<a href="https://starship.rs/config/"><strong>Starshipのドキュメントを見る ▶</strong></a>
|
||||
<a href="https://starship.rs/ja-JP/config/"><strong>Starshipのドキュメントを見る ▶</strong></a>
|
||||
</p>
|
||||
|
||||
<a name="🚀-installation"></a>
|
||||
|
||||
@@ -5,7 +5,7 @@ Starship をインストールするには、以下の2つのことを行う必
|
||||
1. ** starship ** のバイナリをコンピューター上に取得する
|
||||
1. Init スクリプトを修正することで、Starship バイナリをプロンプトとして使用するようシェルに指示する
|
||||
|
||||
ほとんどのユーザーの場合、[メインページ](/guide/#🚀-installation)の説明でうまく動作します。 しかし、より特殊なプラットフォームでは、別の操作が必要になることがあります。
|
||||
ほとんどのユーザーの場合、[メインページ](../guide/#🚀-installation)の説明でうまく動作します。 しかし、より特殊なプラットフォームでは、別の操作が必要になることがあります。
|
||||
|
||||
プラットフォームは無数に存在するため、メインの README.md ファイルには書ききれません。そこで、このページでは、コミュニティにより提供された他のプラットフォーム向けのインストール方法について紹介します。 あなたが使用しているプラットフォームが見当たりませんか？ その場合は是非、見つけた方法をここに追加してください。
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[プリセット一覧に戻る](./README.md#bracketed-segments)
|
||||
[プリセット一覧に戻る](./#bracketed-segments)
|
||||
|
||||
# Bracketed Segmentsプリセット
|
||||
|
||||
@@ -14,4 +14,4 @@ starship preset bracketed-segments -o ~/.config/starship.toml
|
||||
|
||||
[クリックしてTOMLをダウンロード](/presets/toml/bracketed-segments.toml)
|
||||
|
||||
<<< @/.vuepress/public/presets/toml/bracketed-segments.toml
|
||||
<<< @/public/presets/toml/bracketed-segments.toml
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[プリセット一覧に戻る](./README.md#gruvbox-rainbow)
|
||||
[プリセット一覧に戻る](./#gruvbox-rainbow)
|
||||
|
||||
# Gruvbox Rainbow Preset
|
||||
|
||||
@@ -18,4 +18,4 @@ starship preset gruvbox-rainbow -o ~/.config/starship.toml
|
||||
|
||||
[クリックしてTOMLをダウンロード](/presets/toml/gruvbox-rainbow.toml)
|
||||
|
||||
<<< @/.vuepress/public/presets/toml/gruvbox-rainbow.toml
|
||||
<<< @/public/presets/toml/gruvbox-rainbow.toml
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[プリセット一覧に戻る](./README.md#jetpack)
|
||||
[プリセット一覧に戻る](./#jetpack)
|
||||
|
||||
# Jetpack Preset
|
||||
|
||||
@@ -21,4 +21,4 @@ starship preset jetpack -o ~/.config/starship.toml
|
||||
|
||||
[クリックしてTOMLをダウンロード](/presets/toml/jetpack.toml)
|
||||
|
||||
<<< @/.vuepress/public/presets/toml/jetpack.toml
|
||||
<<< @/public/presets/toml/jetpack.toml
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[プリセット一覧に戻る](./README.md#nerd-font-symbols)
|
||||
[プリセット一覧に戻る](./#nerd-font-symbols)
|
||||
|
||||
# Nerd Font Symbolsプリセット
|
||||
|
||||
@@ -18,4 +18,4 @@ starship preset nerd-font-symbols -o ~/.config/starship.toml
|
||||
|
||||
[クリックしてTOMLをダウンロード](/presets/toml/nerd-font-symbols.toml)
|
||||
|
||||
<<< @/.vuepress/public/presets/toml/nerd-font-symbols.toml
|
||||
<<< @/public/presets/toml/nerd-font-symbols.toml
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[プリセット一覧に戻る](./README.md#no-empty-icons)
|
||||
[プリセット一覧に戻る](./#no-empty-icons)
|
||||
|
||||
# No Empty Icons プリセット
|
||||
|
||||
@@ -14,4 +14,4 @@ starship preset no-empty-icons -o ~/.config/starship.toml
|
||||
|
||||
[クリックしてTOMLをダウンロード](/presets/toml/no-empty-icons.toml)
|
||||
|
||||
<<< @/.vuepress/public/presets/toml/no-empty-icons.toml
|
||||
<<< @/public/presets/toml/no-empty-icons.toml
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[プリセット一覧に戻る](./README.md#no-nerd-fonts)
|
||||
[プリセット一覧に戻る](./#no-nerd-fonts)
|
||||
|
||||
# No Nerd Fonts プリセット
|
||||
|
||||
@@ -16,4 +16,4 @@ starship preset no-nerd-font -o ~/.config/starship.toml
|
||||
|
||||
[クリックしてTOMLをダウンロード](/presets/toml/no-nerd-font.toml)
|
||||
|
||||
<<< @/.vuepress/public/presets/toml/no-nerd-font.toml
|
||||
<<< @/public/presets/toml/no-nerd-font.toml
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[プリセット一覧に戻る](./README.md#no-runtime-versions)
|
||||
[プリセット一覧に戻る](./#no-runtime-versions)
|
||||
|
||||
# No Runtime Versionsプリセット
|
||||
|
||||
@@ -14,4 +14,4 @@ starship preset no-runtime-versions -o ~/.config/starship.toml
|
||||
|
||||
[クリックしてTOMLをダウンロード](/presets/toml/no-runtime-versions.toml)
|
||||
|
||||
<<< @/.vuepress/public/presets/toml/no-runtime-versions.toml
|
||||
<<< @/public/presets/toml/no-runtime-versions.toml
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[プリセット一覧に戻る](./README.md#pastel-powerline)
|
||||
[プリセット一覧に戻る](./#pastel-powerline)
|
||||
|
||||
# Pastel Powerlineプリセット
|
||||
|
||||
@@ -18,4 +18,4 @@ starship preset pastel-powerline -o ~/.config/starship.toml
|
||||
|
||||
[クリックしてTOMLをダウンロード](/presets/toml/pastel-powerline.toml)
|
||||
|
||||
<<< @/.vuepress/public/presets/toml/pastel-powerline.toml
|
||||
<<< @/public/presets/toml/pastel-powerline.toml
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[プリセット一覧に戻る](./README.md#plain-text-symbols)
|
||||
[プリセット一覧に戻る](./#plain-text-symbols)
|
||||
|
||||
## Plain Text Symbolsプリセット
|
||||
|
||||
@@ -14,4 +14,4 @@ starship preset plain-text-symbols -o ~/.config/starship.toml
|
||||
|
||||
[クリックしてTOMLをダウンロード](/presets/toml/plain-text-symbols.toml)
|
||||
|
||||
<<< @/.vuepress/public/presets/toml/plain-text-symbols.toml
|
||||
<<< @/public/presets/toml/plain-text-symbols.toml
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[プリセット一覧に戻る](./README.md#pure)
|
||||
[プリセット一覧に戻る](./#pure)
|
||||
|
||||
# Pureプリセット
|
||||
|
||||
@@ -14,4 +14,4 @@ starship preset pure-preset -o ~/.config/starship.toml
|
||||
|
||||
[クリックしてTOMLをダウンロード](/presets/toml/pure-preset.toml)
|
||||
|
||||
<<< @/.vuepress/public/presets/toml/pure-preset.toml
|
||||
<<< @/public/presets/toml/pure-preset.toml
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
[プリセット一覧に戻る](./README.md#pastel-powerline)
|
||||
[プリセット一覧に戻る](./#pastel-powerline)
|
||||
|
||||
# Tokyo Night プリセット
|
||||
|
||||
@@ -18,4 +18,4 @@ starship preset tokyo-night -o ~/.config/starship.toml
|
||||
|
||||
[クリックしてTOMLをダウンロード](/presets/toml/tokyo-night.toml)
|
||||
|
||||
<<< @/.vuepress/public/presets/toml/tokyo-night.toml
|
||||
<<< @/public/presets/toml/tokyo-night.toml
|
||||
|
||||
Reference in New Issue
Block a user