From dc419e8e8ad5b2f0f469788972912af3f71bff45 Mon Sep 17 00:00:00 2001 From: Matan Kushner Date: Wed, 11 Sep 2019 11:57:24 -0400 Subject: [PATCH] docs(i18n): Localize the landing page in Japanese (#333) Co-Authored-By: Yuji Ueki Co-Authored-By: Shu Kutsuzawa Co-Authored-By: heyrict --- docs/.vuepress/config.js | 79 ++++++++++++++++++++++---------- docs/ja/README.md | 99 ++++++++++++++++++++++++++++++++++++++++ 2 files changed, 155 insertions(+), 23 deletions(-) create mode 100644 docs/ja/README.md diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js index 8d299542..50e10752 100644 --- a/docs/.vuepress/config.js +++ b/docs/.vuepress/config.js @@ -1,37 +1,70 @@ module.exports = { - title: 'Starship', - description: 'The cross-shell prompt for astronauts ☄🌌️', - head: [ - ['link', { rel: 'icon', href: '/icon.png' }] - ], + locales: { + "/": { + lang: "en-US", + title: "Starship", + description: "The cross-shell prompt for astronauts" + }, + "/ja/": { + lang: "ja-JP", + title: "Starship", + description: "The cross-shell prompt for astronauts" + } + }, + head: [["link", { rel: "icon", href: "/icon.png" }]], themeConfig: { - logo: '/icon.png', - sidebar: [ - '/', - ['/guide/', 'Guide'], - ['/config/', 'Configuration'], - ['/advanced-config/', 'Advanced Configuration'] - ], - nav: [ - { text: 'Configuration', link: '/config/' }, - ], + logo: "/icon.png", // the GitHub repo path - repo: 'starship/starship', + repo: "starship/starship", // the label linking to the repo - repoLabel: 'GitHub', + repoLabel: "GitHub", // if your docs are not at the root of the repo: - docsDir: 'docs', + docsDir: "docs", // defaults to false, set to true to enable editLinks: true, - // custom text for edit link. Defaults to "Edit this page" - editLinkText: 'Edit this page on GitHub' + 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: [ + "/", + ["/guide/", "Guide"], + ["/config/", "Configuration"], + ["/advanced-config/", "Advanced Configuration"] + ], + }, + "/ja/": { + // 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: "/config/" }], + // Custom sidebar values + sidebar: [ + "/", + ["/guide/", "ガイド"], + ["/config/", "設定"], + ["/advanced-config/", "高度な設定"] + ], + }, + } }, plugins: [ [ - '@vuepress/google-analytics', + "@vuepress/google-analytics", { - 'ga': 'UA-71160903-4' + ga: "UA-71160903-4" } ] ] -} +}; diff --git a/docs/ja/README.md b/docs/ja/README.md new file mode 100644 index 00000000..d86f289c --- /dev/null +++ b/docs/ja/README.md @@ -0,0 +1,99 @@ +--- +home: 'true' +heroImage: "/logo.svg" +actionText: Get Started → +actionLink: "/guide/" +footer: ISC Licensed | Copyright © 2019-present Starship Contributors +--- + +
+
+

互換性優先

+

一般的なほとんどのOSの一般的なほとんどのシェル上で動作します。あらゆるところで使用してください!

+
+
+

Rust 製

+

Rust の最高レベルの速度と安全性を用いることで、可能な限り高速かつ信頼性を高くしています。

+
+
+

カスタマイズ可能

+

それぞれの細かい点は好みにカスタマイズが出来るため、ミニマルにも多機能にも好きなようにプロンプトを設定することができます。

+
+
+ +
+ +
+ +### クイックインストール + +1. **Starship** のバイナリをインストール + + もし以下のプラットフォームを使用していない場合は **[コンパイル済みのバイナリファイルをダウンロード](https://github.com/starship/starship/releases)** してください。 + + #### Homebrew + + ```sh + $ brew install starship + ``` + + #### Rust (v1.33 もしくはそれ以上) + + ```sh + $ cargo install starship + ``` + + #### Arch Linux (AUR) + + Starship は AUR 上の `starship` というパッケージ名で利用可能です。`yay` またはお好きな AUR ヘルパーでインストールしてください。 + + ```sh + $ yay -S starship + ``` + + #### Nix (unstable) + + ```sh + $ nix-env --install starship + ``` + + #### Termux + + ```sh + $ pkg install starship + ``` + +2. 初期化のためのスクリプトをシェルの設定ファイルに追加 + + #### Bash + + `~/.bashrc` の最後に以下を追記してください + + ```sh + # ~/.bashrc + + eval "$(starship init bash)" + ``` + + #### Fish + + `~/.config/fish/config.fish` の最後に以下を追記してください + + ```sh + # ~/.config/fish/config.fish + + eval (starship init fish) + ``` + + #### Zsh + + `~/.zshrc` の最後に以下を追記してください + + ```sh + # ~/.zshrc + + eval "$(starship init zsh)" + ```