From aabe69356a69bb6e151853c3469bd25078734cb1 Mon Sep 17 00:00:00 2001 From: Kazuki Yamada Date: Tue, 14 Jan 2025 23:56:54 +0900 Subject: [PATCH 1/7] docs(website): Add Japanese translation to the documentation --- website/client/.vitepress/config.ts | 93 +-------- website/client/.vitepress/config/configJa.ts | 43 ++++ .../client/.vitepress/config/configShard.ts | 117 +++++++++++ website/client/.vitepress/theme/custom.css | 20 ++ website/client/src/en/index.md | 22 -- .../src/ja/guide/command-line-options.md | 154 ++++++++++++++ .../client/src/ja/guide/comment-removal.md | 127 ++++++++++++ website/client/src/ja/guide/configuration.md | 162 +++++++++++++++ .../src/ja/guide/custom-instructions.md | 87 ++++++++ .../client/src/ja/guide/development/index.md | 42 ++++ .../client/src/ja/guide/development/setup.md | 74 +++++++ website/client/src/ja/guide/index.md | 60 ++++++ website/client/src/ja/guide/installation.md | 130 ++++++++++++ website/client/src/ja/guide/output.md | 151 ++++++++++++++ .../client/src/ja/guide/prompt-examples.md | 137 +++++++++++++ .../ja/guide/remote-repository-processing.md | 98 +++++++++ website/client/src/ja/guide/security.md | 71 +++++++ .../src/ja/guide/tips/best-practices.md | 75 +++++++ website/client/src/ja/guide/usage.md | 151 ++++++++++++++ website/client/src/ja/index.md | 191 ++++++++++++++++++ website/client/tsconfig.json | 5 - website/client/tsconfig.node.json | 6 +- 22 files changed, 1900 insertions(+), 116 deletions(-) create mode 100644 website/client/.vitepress/config/configJa.ts create mode 100644 website/client/.vitepress/config/configShard.ts create mode 100644 website/client/src/ja/guide/command-line-options.md create mode 100644 website/client/src/ja/guide/comment-removal.md create mode 100644 website/client/src/ja/guide/configuration.md create mode 100644 website/client/src/ja/guide/custom-instructions.md create mode 100644 website/client/src/ja/guide/development/index.md create mode 100644 website/client/src/ja/guide/development/setup.md create mode 100644 website/client/src/ja/guide/index.md create mode 100644 website/client/src/ja/guide/installation.md create mode 100644 website/client/src/ja/guide/output.md create mode 100644 website/client/src/ja/guide/prompt-examples.md create mode 100644 website/client/src/ja/guide/remote-repository-processing.md create mode 100644 website/client/src/ja/guide/security.md create mode 100644 website/client/src/ja/guide/tips/best-practices.md create mode 100644 website/client/src/ja/guide/usage.md create mode 100644 website/client/src/ja/index.md diff --git a/website/client/.vitepress/config.ts b/website/client/.vitepress/config.ts index 300f18b81..90ba0db0a 100644 --- a/website/client/.vitepress/config.ts +++ b/website/client/.vitepress/config.ts @@ -1,95 +1,12 @@ import { defineConfig } from 'vitepress'; +import { configShard } from './config/configShard'; import { configEn } from './config/configEn'; +import { configJa } from './config/configJa'; -const googleAnalyticsTag = 'G-7PTT4PLC69'; - -/** - * Vitepress Configuration - * - * Reference - * see: https://github.com/vuejs/vitepress/tree/main/docs - */ export default defineConfig({ - title: 'Repomix', - - srcDir: 'src', - - rewrites: { - // rewrite to `en` locale - 'en/:rest*': ':rest*', - }, - - lastUpdated: true, - cleanUrls: true, - metaChunk: true, - - sitemap: { - hostname: 'http://repomix.com/', - }, - - // Shared configuration - themeConfig: { - logo: { src: '/images/repomix-logo.svg', width: 24, height: 24 }, - search: { - provider: 'local', - }, - socialLinks: [ - { icon: 'discord', link: 'https://discord.gg/wNYzTwZFku' }, - { icon: 'github', link: 'https://github.com/yamadashy/repomix' }, - ], - footer: { - message: 'Released under the MIT License.', - copyright: 'Copyright © 2024 Kazuki Yamada', - }, - }, - - // i18n configuration + ...configShard, locales: { - root: { - label: 'English', - lang: 'en-US', - ...configEn, - }, + root: { label: 'English', ...configEn }, + ja: { label: '日本語', ...configJa }, }, - - head: [ - // Favicon - ['link', { rel: 'icon', href: '/images/repomix-logo.svg' }], - - // OGP - ['meta', { property: 'og:type', content: 'website' }], - ['meta', { property: 'og:locale', content: 'en' }], - ['meta', { property: 'og:title', content: 'Repomix' }], - ['meta', { property: 'og:site_name', content: 'Repomix' }], - ['meta', { property: 'og:image', content: 'https://repomix.com/images/og-image-large.png' }], - ['meta', { property: 'og:url', content: 'https://repomix.com' }], - ['meta', { property: 'og:description', content: 'Pack your codebase into AI-friendly formats' }], - ['meta', { name: 'twitter:card', content: 'summary_large_image' }], - ['meta', { property: 'twitter:domain', content: 'https://repomix.com' }], - ['meta', { property: 'twitter:url', content: 'https://repomix.com' }], - ['meta', { name: 'twitter:title', content: 'Repomix' }], - ['meta', { name: 'twitter:description', content: 'Pack your codebase into AI-friendly formats' }], - ['meta', { name: 'twitter:image', content: 'https://repomix.com/images/og-image-large.png' }], - ['meta', { name: 'thumbnail', content: 'https://repomix.com/images/og-image-large.png' }], - - // PWA - ['meta', { name: 'theme-color', content: '#f97316' }], - - // Google Analytics - [ - 'script', - { - async: true, - src: `https://www.googletagmanager.com/gtag/js?id=${googleAnalyticsTag}`, - }, - ], - [ - 'script', - {}, - `window.dataLayer = window.dataLayer || []; - function gtag(){dataLayer.push(arguments);} - gtag('js', new Date()); - gtag('config', '${googleAnalyticsTag}');`, - ], - ], }); diff --git a/website/client/.vitepress/config/configJa.ts b/website/client/.vitepress/config/configJa.ts new file mode 100644 index 000000000..c3767f333 --- /dev/null +++ b/website/client/.vitepress/config/configJa.ts @@ -0,0 +1,43 @@ +import { defineConfig } from 'vitepress'; + +export const configJa = defineConfig({ + lang: 'ja', + description: 'コードベースをAIフレンドリーな形式にパッケージング', + themeConfig: { + nav: [ + { text: '使い方', link: '/ja/guide/' }, + { text: 'Discordに参加', link: 'https://discord.gg/wNYzTwZFku' }, + ], + sidebar: { + '/ja/guide/': [ + { + text: '使い方', + items: [ + { text: 'はじめに', link: '/ja/guide/' }, + { text: 'インストール', link: '/ja/guide/installation' }, + { text: '基本的な使い方', link: '/ja/guide/usage' }, + { text: 'プロンプト例', link: '/ja/guide/prompt-examples' }, + { text: '出力フォーマット', link: '/ja/guide/output' }, + { text: 'コマンドラインオプション', link: '/ja/guide/command-line-options' }, + { text: 'リモートリポジトリの処理', link: '/ja/guide/remote-repository-processing' }, + { text: '設定', link: '/ja/guide/configuration' }, + { text: 'カスタム指示', link: '/ja/guide/custom-instructions' }, + { text: 'コメントの削除', link: '/ja/guide/comment-removal' }, + { text: 'セキュリティ', link: '/ja/guide/security' }, + { + text: 'ヒント＆テクニック', + items: [{ text: 'ベストプラクティス', link: '/ja/guide/tips/best-practices' }], + }, + { + text: '開発', + items: [ + { text: '開発への貢献', link: '/ja/guide/development/' }, + { text: '環境構築', link: '/ja/guide/development/setup' }, + ], + }, + ], + }, + ], + }, + }, +}); diff --git a/website/client/.vitepress/config/configShard.ts b/website/client/.vitepress/config/configShard.ts new file mode 100644 index 000000000..46ed2afc5 --- /dev/null +++ b/website/client/.vitepress/config/configShard.ts @@ -0,0 +1,117 @@ +import { defineConfig } from 'vitepress'; + +const googleAnalyticsTag = 'G-7PTT4PLC69'; + +export const configShard = defineConfig({ + title: 'Repomix', + + srcDir: 'src', + + rewrites: { + // rewrite to `en` locale + 'en/:rest*': ':rest*', + }, + + lastUpdated: true, + cleanUrls: true, + metaChunk: true, + + sitemap: { + hostname: 'http://repomix.com/', + }, + + // Shared configuration + themeConfig: { + logo: { src: '/images/repomix-logo.svg', width: 24, height: 24 }, + search: { + provider: 'local', + options: { + locales: { + root: { + translations: { + button: { + buttonText: 'Search', + buttonAriaLabel: 'Search' + }, + modal: { + noResultsText: 'No results', + resetButtonTitle: 'Reset search', + footer: { + selectText: 'to select', + navigateText: 'to navigate' + } + } + } + }, + ja: { + translations: { + button: { + buttonText: '検索', + buttonAriaLabel: '検索' + }, + modal: { + noResultsText: '検索結果がありません', + resetButtonTitle: '検索をリセット', + footer: { + selectText: '選択', + navigateText: '移動' + } + } + } + } + } + } + }, + socialLinks: [ + { icon: 'discord', link: 'https://discord.gg/wNYzTwZFku' }, + { icon: 'github', link: 'https://github.com/yamadashy/repomix' }, + ], + footer: { + message: 'Released under the MIT License.', + copyright: 'Copyright © 2024 Kazuki Yamada', + }, + // Language selection + langMenuLabel: '言語', + }, + + head: [ + // Favicon + ['link', { rel: 'icon', href: '/images/repomix-logo.svg' }], + + // OGP + ['meta', { property: 'og:type', content: 'website' }], + ['meta', { property: 'og:locale', content: 'en' }], + ['meta', { property: 'og:title', content: 'Repomix' }], + ['meta', { property: 'og:site_name', content: 'Repomix' }], + ['meta', { property: 'og:image', content: 'https://repomix.com/images/og-image-large.png' }], + ['meta', { property: 'og:url', content: 'https://repomix.com' }], + ['meta', { property: 'og:description', content: 'Pack your codebase into AI-friendly formats' }], + ['meta', { name: 'twitter:card', content: 'summary_large_image' }], + ['meta', { property: 'twitter:domain', content: 'https://repomix.com' }], + ['meta', { property: 'twitter:url', content: 'https://repomix.com' }], + ['meta', { name: 'twitter:title', content: 'Repomix' }], + ['meta', { name: 'twitter:description', content: 'Pack your codebase into AI-friendly formats' }], + ['meta', { name: 'twitter:image', content: 'https://repomix.com/images/og-image-large.png' }], + ['meta', { name: 'thumbnail', content: 'https://repomix.com/images/og-image-large.png' }], + + // PWA + ['meta', { name: 'theme-color', content: '#f97316' }], + + // Google Analytics + [ + 'script', + { + async: true, + src: `https://www.googletagmanager.com/gtag/js?id=${googleAnalyticsTag}`, + }, + ], + [ + 'script', + {}, + `window.dataLayer = window.dataLayer || []; + function gtag(){dataLayer.push(arguments);} + gtag('js', new Date()); + gtag('config', '${googleAnalyticsTag}');`, + ], + ], +}); diff --git a/website/client/.vitepress/theme/custom.css b/website/client/.vitepress/theme/custom.css index 52e941105..c30bda115 100644 --- a/website/client/.vitepress/theme/custom.css +++ b/website/client/.vitepress/theme/custom.css @@ -10,3 +10,23 @@ --vp-home-hero-image-background-image: linear-gradient(-45deg, rgba(249, 115, 22, 0.3) 30%, rgba(249, 115, 22, 0.1)); --vp-home-hero-image-filter: blur(96px); } + +.hero-description__accent { + color: var(--vp-c-brand-1); +} +.cli-section { + padding-top: 64px; + margin-bottom: 32px; + max-width: 800px; + margin-left: auto; + margin-right: auto; +} + +.cli-section h2 { + font-size: 2rem; + font-weight: 600; + margin-bottom: 1.5rem; + background: linear-gradient(120deg, #f97316 30%, #ffb25c); + -webkit-background-clip: text; + -webkit-text-fill-color: transparent; +} diff --git a/website/client/src/en/index.md b/website/client/src/en/index.md index aa9e1a22c..0c95990e9 100644 --- a/website/client/src/en/index.md +++ b/website/client/src/en/index.md @@ -190,25 +190,3 @@ Create a `repomix.config.json` for persistent settings: ::: - - diff --git a/website/client/src/ja/guide/command-line-options.md b/website/client/src/ja/guide/command-line-options.md new file mode 100644 index 000000000..0a747f0f1 --- /dev/null +++ b/website/client/src/ja/guide/command-line-options.md @@ -0,0 +1,154 @@ +# コマンドラインオプション + +Repomix は、コマンドラインから実行する際に、さまざまなオプションを指定することで、動作をカスタマイズできます。このドキュメントでは、Repomix の主要なコマンドラインオプションとその使用方法について説明します。 + +## 基本的なオプション + +### `--version` + +Repomix のバージョンを表示します。 + +```bash +repomix --version +``` + +### `--help` + +Repomix のヘルプメッセージを表示します。すべてのオプションと使用方法を確認できます。 + +```bash +repomix --help +``` + +## 処理対象の指定 + +### `` + +処理対象のファイルを指定します。複数のファイルを指定することも可能です。 + +```bash +repomix src/index.ts +repomix src/index.ts src/utils.ts +``` + +### `` + +処理対象のディレクトリを指定します。指定したディレクトリ内のすべてのファイルが処理対象となります。 + +```bash +repomix src/ +``` + +## 動作の制御 + +### `--prompt ` + +実行するタスクを自然言語で指定します。 + +```bash +repomix src/index.ts --prompt "このコードをレビューしてください。" +``` + +### `--output-style