From 0d957afcc307ab2981e21803cc202d8935879327 Mon Sep 17 00:00:00 2001 From: leirui2 Date: Sat, 4 Apr 2026 17:54:20 +0800 Subject: [PATCH] chore: add translations by GitHub Global --- README.md | 8 +- translations/en/README.md | 143 +++++++++++++++++++ translations/en/docs/README.md | 245 +++++++++++++++++++++++++++++++++ translations/ja/README.md | 143 +++++++++++++++++++ translations/ja/docs/README.md | 245 +++++++++++++++++++++++++++++++++ translations/ko/README.md | 138 +++++++++++++++++++ translations/ko/docs/README.md | 245 +++++++++++++++++++++++++++++++++ 7 files changed, 1166 insertions(+), 1 deletion(-) create mode 100644 translations/en/README.md create mode 100644 translations/en/docs/README.md create mode 100644 translations/ja/README.md create mode 100644 translations/ja/docs/README.md create mode 100644 translations/ko/README.md create mode 100644 translations/ko/docs/README.md diff --git a/README.md b/README.md index 512e27fa..f7603471 100644 --- a/README.md +++ b/README.md @@ -6,6 +6,12 @@ [在线文档](https://weifeng2333.github.io/VideoCaptioner/) · [CLI 使用](#cli-命令行) · [GUI 桌面版](#gui-桌面版) · [Claude Code Skill](#claude-code-skill) +## 🌐 Translations + +[English](./translations/en/README.md) | [한국어](./translations/ko/README.md) | [日本語](./translations/ja/README.md) + +--- + ## 安装 ```bash @@ -140,4 +146,4 @@ uv run pytest tests/test_cli/ -q # 运行测试 [GPL-3.0](LICENSE) -[![Star History Chart](https://api.star-history.com/svg?repos=WEIFENG2333/VideoCaptioner&type=Date)](https://star-history.com/#WEIFENG2333/VideoCaptioner&Date) +[![Star History Chart](https://api.star-history.com/svg?repos=WEIFENG2333/VideoCaptioner&type=Date)](https://star-history.com/#WEIFENG2333/VideoCaptioner&Date) \ No newline at end of file diff --git a/translations/en/README.md b/translations/en/README.md new file mode 100644 index 00000000..f2561482 --- /dev/null +++ b/translations/en/README.md @@ -0,0 +1,143 @@ +
+ VideoCaptioner Logo +

VideoCaptioner

+

A video subtitle processing tool based on large language models — a one-stop solution for speech recognition, subtitle optimization, translation, and video synthesis

+ + [Online Documentation](https://weifeng2333.github.io/VideoCaptioner/) · [CLI Usage](#cli-usage) · [GUI Desktop Version](#gui-desktop-version) · [Claude Code Skill](#claude-code-skill) +
+ +## Installation + +```bash +pip install videocaptioner # Install CLI only (lightweight, no GUI dependencies) +pip install videocaptioner[gui] # Install CLI + GUI desktop version +``` + +Free features (Bijiang speech recognition, Bing/Google translation) **require no configuration, ready to use after installation**. + +## CLI Usage + +```bash +# Speech transcription (free, no API Key required) +videocaptioner transcribe video.mp4 --asr bijian + +# Subtitle translation (free Bing translation) +videocaptioner subtitle input.srt --translator bing --target-language en + +# Full process: transcription → optimization → translation → synthesis +videocaptioner process video.mp4 --target-language ja + +# Burn subtitles into video +videocaptioner synthesize video.mp4 -s subtitle.srt + +# Download online videos +videocaptioner download "https://youtube.com/watch?v=xxx" +``` + +When LLM features (subtitle optimization, large model translation) are needed, configure API Key: + +```bash +videocaptioner config set llm.api_key +videocaptioner config set llm.api_base https://api.openai.com/v1 +videocaptioner config set llm.model gpt-4o-mini +``` + +Configuration priority: `command line arguments > environment variables (VIDEOCAPTIONER_*) > configuration files > default values`. Run `videocaptioner config show` to view the current configuration. + +
+All CLI Commands Overview + +| Command | Description | +|---------|-------------| +| `transcribe` | Speech to subtitle. Engines: `faster-whisper`, `whisper-api`, `bijian` (free), `jianying` (free), `whisper-cpp` | +| `subtitle` | Subtitle optimization/translation. Translation services: `llm`, `bing` (free), `google` (free) | +| `synthesize` | Burn subtitles into video (soft subtitles/hard subtitles) | +| `process` | Full process handling | +| `download` | Download videos from platforms like YouTube and Bilibili | +| `config` | Configuration management (`show`, `set`, `get`, `path`, `init`) | + +Run `videocaptioner --help` to see full parameters. Complete CLI documentation available at [docs/cli.md](docs/cli.md). + +
+ +## GUI Desktop Version + +```bash +pip install videocaptioner[gui] +videocaptioner # Automatically opens desktop version with no parameters +``` + +
+Other Installation Methods: Windows Installer / macOS One-Click Script + +**Windows**: Download the installer from [Release](https://github.com/WEIFENG2333/VideoCaptioner/releases) + +**macOS**: +```bash +curl -fsSL https://raw.githubusercontent.com/WEIFENG2333/VideoCaptioner/master/scripts/run.sh | bash +``` + +
+ + + + +![Page Preview](https://h1.appinn.me/file/1731487410170_preview1.png) +![Page Preview](https://h1.appinn.me/file/1731487410832_preview2.png) + +## LLM API Configuration + +LLM is used only for subtitle optimization and large model translation; free functions (Bijiang recognition, Bing translation) require no configuration. + +Supports all OpenAI-compatible service providers: + +| Provider | Website | +|----------|---------| +| **VideoCaptioner Relay** | [api.videocaptioner.cn](https://api.videocaptioner.cn) — High concurrency, cost-effective, supports GPT/Claude/Gemini, etc. | +| SiliconCloud | [cloud.siliconflow.cn](https://cloud.siliconflow.cn/i/HF95kaoz) | +| DeepSeek | [platform.deepseek.com](https://platform.deepseek.com) | + +Fill in the API Base URL and API Key in the software settings or CLI. [Detailed configuration tutorial](https://weifeng2333.github.io/VideoCaptioner/config/llm) + +## Claude Code Skill + +This project provides a [Claude Code Skill](https://code.claude.com/docs/en/skills.md), allowing the AI programming assistant to directly call VideoCaptioner to process videos. + +Install to Claude Code: + +```bash +mkdir -p ~/.claude/skills/videocaptioner +cp skills/SKILL.md ~/.claude/skills/videocaptioner/SKILL.md +``` + +Then enter `/videocaptioner transcribe video.mp4 --asr bijian` in Claude Code to use it. + +## Working Principle + +``` +Audio/Video Input → Speech Recognition → Subtitle Segmentation → LLM Optimization → Translation → Video Synthesis +``` + +- Word-level timestamps + VAD speech activity detection, high accuracy +- LLM semantic understanding for segmentation, providing a natural and smooth subtitle reading experience +- Context-aware translation, supporting reflective optimization mechanisms +- High-efficiency bulk concurrent processing + +## Development + +```bash +git clone https://github.com/WEIFENG2333/VideoCaptioner.git +cd VideoCaptioner +uv sync && uv run videocaptioner # Run GUI +uv run videocaptioner --help # Run CLI +uv run pyright # Type checking +uv run pytest tests/test_cli/ -q # Run tests +``` + +## License + +[GPL-3.0](LICENSE) + +[![Star History Chart](https://api.star-history.com/svg?repos=WEIFENG2333/VideoCaptioner&type=Date)](https://star-history.com/#WEIFENG2333/VideoCaptioner&Date) \ No newline at end of file diff --git a/translations/en/docs/README.md b/translations/en/docs/README.md new file mode 100644 index 00000000..e3034c39 --- /dev/null +++ b/translations/en/docs/README.md @@ -0,0 +1,245 @@ +# VideoCaptioner Documentation + +This is the documentation source file for the VideoCaptioner project, built with [VitePress](https://vitepress.dev/).## 📚 Online View + +The documentation has been automatically deployed to GitHub Pages: + +**[https://weifeng2333.github.io/VideoCaptioner/](https://weifeng2333.github.io/VideoCaptioner/)**## 🚀 Local Development + +### Install Dependencies + +```bash +npm install +``` + +### Start Development Server + +```bash +npm run docs:dev +``` + +Visit http://localhost:5173 to view the documentation + +### Build Documentation + +```bash +npm run docs:build +``` + +The build artifacts are located in `docs/.vitepress/dist/` + +### Preview Build Results + +```bash +npm run docs:preview +```## 📁 Directory Structure + +``` +docs/ +├── .vitepress/ +│ ├── config.mts # VitePress configuration file (including SEO optimization) +│ └── theme/ # Custom theme (optional) +├── public/ # Static assets (images, logo, robots.txt) +├── guide/ # English user guide +│ ├── getting-started.md +│ ├── configuration.md +│ └── ... +├── config/ # English configuration documentation +│ ├── llm.md +│ ├── asr.md +│ └── ... +├── dev/ # English developer documentation +│ ├── architecture.md +│ └── ... +├── en/ # English documentation (mirroring Chinese structure) +│ ├── guide/ +│ ├── config/ +│ └── dev/ +└── index.md # English homepage +```## ✍️ Contribution Guidelines + +### Adding a New Page + +1. Create a Markdown file in the corresponding directory. +2. **Add Frontmatter for SEO Optimization** (Important!): + +```markdown +--- +title: Page Title - VideoCaptioner +description: Page description including keywords +head: + - - meta + - name: keywords + content: keyword1,keyword2,keyword3 +--- + +# Page Title + +Content... +``` + +3. Add a link in the `sidebar` of `.vitepress/config.mts`. +4. Submit a PR. + +### Editing an Existing Page + +Simply edit the Markdown file; it supports: + +- **Markdown Extended Syntax**: Tables, code blocks, tip boxes, etc. +- **Vue Components**: Vue components can be used within Markdown. +- **Custom Containers**: `::: tip`, `::: warning`, `::: danger` + +Example: + +```md +::: tip Tip +This is a tip box. +::: + +::: warning Warning +This is a warning box. +::: + +::: danger Danger +This is a danger warning box. +::: +``` + +### Documentation Standards + +- **File Name**: Use lowercase letters and hyphens (e.g., `getting-started.md`). +- **Title**: Use a clear hierarchical structure (# → ## → ###). +- **Code Blocks**: Specify the language type to enable syntax highlighting. +- **Images**: Place in the `public/` directory, referenced as `/image.png`. +- **Links**: Internal links should use relative paths (e.g., `/guide/getting-started`). +- **SEO**: Each page should include a title, description, and keywords.## 🔍 SEO Optimization + +This document system has been fully optimized for SEO. For details, please refer to [SEO_OPTIMIZATION.md](../SEO_OPTIMIZATION.md). + +### Implemented SEO Features + +✅ **Basic SEO** + +- Title tag optimization +- Meta Description and Keywords +- Open Graph (social media cards) +- Twitter Card +- JSON-LD structured data +- Sitemap auto-generation +- robots.txt +- Canonical URL + +✅ **Technical SEO** + +- Responsive design +- Clean URLs +- Fast loading (Vite optimization) +- HTTPS (GitHub Pages) + +### Submission to Search Engines + +After deployment, it is necessary to manually submit to search engines: + +1. **Google Search Console** + - Visit https://search.google.com/search-console + - Add and verify the website + - Submit sitemap: `https://weifeng2333.github.io/VideoCaptioner/sitemap.xml` + +2. **Bing Webmaster Tools** + - Visit https://www.bing.com/webmasters + - Add and verify the website + - Submit sitemap + +3. **Baidu Webmaster Platform** + - Visit https://ziyuan.baidu.com/ + - Add and verify the website + - Submit sitemap + +### SEO Check Tools + +- [Google PageSpeed Insights](https://pagespeed.web.dev/) +- [Google Rich Results Test](https://search.google.com/test/rich-results) +- [Open Graph Debugger](https://developers.facebook.com/tools/debug/) +- [Twitter Card Validator](https://cards-dev.twitter.com/validator)## 🌐 Multilingual Support + +The documentation supports both Chinese and English: + +- **Chinese**: `docs/` root directory +- **English**: `docs/en/` directory + +To add a new language: + +1. Create a language directory (e.g., `ja/`) under `docs/` +2. Add locale configuration in `.vitepress/config.mts` +3. Copy the document structure and translate the content## 🔧 Tech Stack + +- **VitePress**: A static site generator based on Vite +- **Vue 3**: Component-based development +- **TypeScript**: Type-safe configuration## 📝 Update Documentation + +Document updates trigger GitHub Actions deployments automatically: + +1. Submit document changes to the `docs/` directory +2. Push to the `master` or `main` branch +3. GitHub Actions automatically builds and deploys +4. Updates take effect in about 2-3 minutes## ❓ Frequently Asked Questions + +### Why can't I see styles during local development? + +Make sure the dependencies are installed: + +```bash +npm install +``` + +### How to add custom styles? + +Create a custom theme in the `docs/.vitepress/theme/` directory: + +```ts +// docs/.vitepress/theme/index.ts +import DefaultTheme from "vitepress/theme"; +import "./custom.css"; + +export default DefaultTheme; +``` + +### How to configure the search function? + +VitePress provides a local search by default, which is configured in `config.mts`. + +### How to optimize images? + +1. Use image compression tools (like TinyPNG) +2. Consider using WebP format +3. Add the `loading="lazy"` attribute + +### How to add Google Analytics? + +Add the following to the `head` in `config.mts`: + +```typescript +([ + "script", + { + async: true, + src: "https://www.googletagmanager.com/gtag/js?id=G-XXXXXXXXXX", + }, +], + [ + "script", + {}, + ` + window.dataLayer = window.dataLayer || []; + function gtag(){dataLayer.push(arguments);} + gtag('js', new Date()); + gtag('config', 'G-XXXXXXXXXX'); +`, + ]); +``` + +--- + +For more usage methods of VitePress, please refer to the [official documentation](https://vitepress.dev/) . + +For more details on SEO optimization, please check [SEO_OPTIMIZATION.md](../SEO_OPTIMIZATION.md). \ No newline at end of file diff --git a/translations/ja/README.md b/translations/ja/README.md new file mode 100644 index 00000000..9d24aae0 --- /dev/null +++ b/translations/ja/README.md @@ -0,0 +1,143 @@ +
+ VideoCaptioner Logo +

VideoCaptioner

+

大規模言語モデルに基づく動画字幕処理ツール — 音声認識、字幕最適化、翻訳、動画合成のワンストップ処理

+ + [オンラインドキュメント](https://weifeng2333.github.io/VideoCaptioner/) · [CLI 使用法](#cli-コマンドライン) · [GUI デスクトップ版](#gui-デスクトップ版) · [Claude Code Skill](#claude-code-skill) +
+ +## インストール + +```bash +pip install videocaptioner # CLI のみをインストール（軽量、GUI 依存なし） +pip install videocaptioner[gui] # CLI + GUI デスクトップ版をインストール +``` + +無料機能（必剪音声認識、必応/グーグル翻訳）**は設定不要、インストールしてすぐに使えます**。 + +## CLI コマンドライン + +```bash +# 音声転写（無料、APIキー不要） +videocaptioner transcribe video.mp4 --asr bijian + +# 字幕翻訳（無料の必応翻訳） +videocaptioner subtitle input.srt --translator bing --target-language en + +# 全プロセス：転写 → 最適化 → 翻訳 → 合成 +videocaptioner process video.mp4 --target-language ja + +# 字幕を動画に焼き付ける +videocaptioner synthesize video.mp4 -s subtitle.srt + +# オンライン動画のダウンロード +videocaptioner download "https://youtube.com/watch?v=xxx" +``` + +LLM 機能（字幕最適化、大規模モデル翻訳）が必要な場合は、API キーを設定します： + +```bash +videocaptioner config set llm.api_key +videocaptioner config set llm.api_base https://api.openai.com/v1 +videocaptioner config set llm.model gpt-4o-mini +``` + +設定の優先順位：`コマンドライン引数 > 環境変数 (VIDEOCAPTIONER_*) > 設定ファイル > デフォルト値`。現在の設定は `videocaptioner config show` で確認できます。 + +
+すべての CLI コマンド一覧 + +| コマンド | 説明 | +|------|------| +| `transcribe` | 音声を字幕に変換します。エンジン：`faster-whisper`、`whisper-api`、`bijian`（無料）、`jianying`（無料）、`whisper-cpp` | +| `subtitle` | 字幕の最適化/翻訳。翻訳サービス：`llm`、`bing`（無料）、`google`（無料） | +| `synthesize` | 字幕を動画に焼き付ける（ソフト字幕/ハード字幕） | +| `process` | 全プロセス処理 | +| `download` | YouTube、Bilibili などのプラットフォームから動画をダウンロード | +| `config` | 設定管理（`show`、`set`、`get`、`path`、`init`） | + +`videocaptioner <コマンド> --help` を実行して完全なパラメータを確認できます。完全な CLI ドキュメントは [docs/cli.md](docs/cli.md) を参照してください。 + +
+ +## GUI デスクトップ版 + +```bash +pip install videocaptioner[gui] +videocaptioner # 引数なしでデスクトップ版を自動で開く +``` + +
+その他のインストール方法：Windows インストーラ / macOS ワンキースクリプト + +**Windows**： [Release](https://github.com/WEIFENG2333/VideoCaptioner/releases) からインストーラをダウンロードしてインストール + +**macOS**： +```bash +curl -fsSL https://raw.githubusercontent.com/WEIFENG2333/VideoCaptioner/master/scripts/run.sh | bash +``` + +
+ + + + +![ページプレビュー](https://h1.appinn.me/file/1731487410170_preview1.png) +![ページプレビュー](https://h1.appinn.me/file/1731487410832_preview2.png) + +## LLM API 設定 + +LLM は字幕の最適化と大規模モデル翻訳のみに使用され、無料機能（必剪認識、必応翻訳）は設定不要です。 + +すべての OpenAI 互換インターフェースを持つサービスプロバイダーをサポート： + +| サービスプロバイダー | 公式サイト | +|--------|------| +| **VideoCaptioner 中継所** | [api.videocaptioner.cn](https://api.videocaptioner.cn) — 高い同時接続性、コストパフォーマンスが高い、GPT/Claude/Gemini などをサポート | +| SiliconCloud | [cloud.siliconflow.cn](https://cloud.siliconflow.cn/i/HF95kaoz) | +| DeepSeek | [platform.deepseek.com](https://platform.deepseek.com) | + +ソフトウェア設定または CLI で API Base URL と API Key を入力するだけです。[詳細な設定ガイド](https://weifeng2333.github.io/VideoCaptioner/config/llm) + +## Claude Code Skill + +本プロジェクトは、AI プログラミングアシスタントが VideoCaptioner を呼び出して動画を処理できる [Claude Code Skill](https://code.claude.com/docs/en/skills.md) を提供しています。 + +Claude Code にインストールするには： + +```bash +mkdir -p ~/.claude/skills/videocaptioner +cp skills/SKILL.md ~/.claude/skills/videocaptioner/SKILL.md +``` + +その後、Claude Code で `/videocaptioner transcribe video.mp4 --asr bijian` と入力すれば、使用できます。 + +## 動作原理 + +``` +音声・動画入力 → 音声認識 → 字幕分割 → LLM 最適化 → 翻訳 → 動画合成 +``` + +- 単語レベルのタイムスタンプ + VAD 音声活動検出、高い認識精度 +- LLM の意味理解に基づく文分割、字幕の読みやすい体験 +- コンテキストを考慮した翻訳、反省最適化メカニズムをサポート +- バッチ並列処理、高効率 + +## 開発 + +```bash +git clone https://github.com/WEIFENG2333/VideoCaptioner.git +cd VideoCaptioner +uv sync && uv run videocaptioner # GUI を実行 +uv run videocaptioner --help # CLI を実行 +uv run pyright # 型チェック +uv run pytest tests/test_cli/ -q # テストを実行 +``` + +## ライセンス + +[GPL-3.0](LICENSE) + +[![スター履歴チャート](https://api.star-history.com/svg?repos=WEIFENG2333/VideoCaptioner&type=Date)](https://star-history.com/#WEIFENG2333/VideoCaptioner&Date) \ No newline at end of file diff --git a/translations/ja/docs/README.md b/translations/ja/docs/README.md new file mode 100644 index 00000000..01ebec07 --- /dev/null +++ b/translations/ja/docs/README.md @@ -0,0 +1,245 @@ +# VideoCaptioner ドキュメント + +これは VideoCaptioner プロジェクトのドキュメントソースファイルで、[VitePress](https://vitepress.dev/) を使用して構築されています。## 📚 オンライン表示 + +ドキュメントは自動的に GitHub Pages にデプロイされました： + +**[https://weifeng2333.github.io/VideoCaptioner/](https://weifeng2333.github.io/VideoCaptioner/)**## 🚀 ローカル開発 + +### 依存関係のインストール + +```bash +npm install +``` + +### 開発サーバーの起動 + +```bash +npm run docs:dev +``` + +http://localhost:5173 にアクセスしてドキュメントを確認してください + +### ドキュメントのビルド + +```bash +npm run docs:build +``` + +ビルド成果物は `docs/.vitepress/dist/` にあります + +### ビルド結果のプレビュー + +```bash +npm run docs:preview +```## 📁 ディレクトリ構造 + +``` +docs/ +├── .vitepress/ +│ ├── config.mts # VitePress 設定ファイル（SEO 最適化を含む） +│ └── theme/ # カスタムテーマ（オプショナル） +├── public/ # 静的リソース（画像、ロゴ、robots.txt） +├── guide/ # 日本語使用ガイド +│ ├── getting-started.md +│ ├── configuration.md +│ └── ... +├── config/ # 日本語設定文書 +│ ├── llm.md +│ ├── asr.md +│ └── ... +├── dev/ # 日本語開発者文書 +│ ├── architecture.md +│ └── ... +├── en/ # 英語文書（日本語構造のミラー） +│ ├── guide/ +│ ├── config/ +│ └── dev/ +└── index.md # 日本語ホームページ +```## ✍️ 貢献ドキュメント + +### 新しいページの追加 + +1. 対応するディレクトリに Markdown ファイルを作成 +2. **Frontmatter SEO 最適化を追加**（重要！）： + +```markdown +--- +title: ページタイトル - VideoCaptioner +description: ページの説明、キーワードを含む +head: + - - meta + - name: keywords + content: キーワード1,キーワード2,キーワード3 +--- + +# ページタイトル + +内容... +``` + +3. `.vitepress/config.mts` の `sidebar` にリンクを追加 +4. PR を提出 + +### 既存ページの編集 + +Markdown ファイルを直接編集するだけで大丈夫です。サポート内容： + +- **Markdown 拡張構文**：表、コードブロック、ヒントボックスなど +- **Vue コンポーネント**：Markdown 内で Vue コンポーネントが使用可能 +- **カスタムコンテナ**：`::: tip`, `::: warning`, `::: danger` + +例： + +```md +::: tip ヒント +これはヒントボックスです +::: + +::: warning 注意 +これは警告ボックスです +::: + +::: danger 危険 +これは危険警告ボックスです +::: +``` + +### ドキュメント規範 + +- **ファイル名**：小文字とハイフンを使用（例： `getting-started.md`） +- **タイトル**：明確な階層構造を使用（# → ## → ###） +- **コードブロック**：言語タイプを指定して構文ハイライトを有効化 +- **画像**：`public/` ディレクトリに置き、 `/image.png` で参照 +- **リンク**：内部リンクは相対パスを使用（例： `/guide/getting-started`） +- **SEO**：各ページには title、description、keywords を追加すること## 🔍 SEO最適化 + +本文書システムは全面的にSEO最適化されています。詳細は[SEO_OPTIMIZATION.md](../SEO_OPTIMIZATION.md)をご覧ください。 + +### 実施されたSEO機能 + +✅ **基本的なSEO** + +- Titleタグの最適化 +- Meta DescriptionとKeywords +- Open Graph（ソーシャルメディアカード） +- Twitter Card +- JSON-LD構造化データ +- Sitemapの自動生成 +- robots.txt +- Canonical URL + +✅ **技術的SEO** + +- レスポンシブデザイン +- クリーンURL +- 高速ロード（Vite最適化） +- HTTPS（GitHub Pages） + +### 検索エンジンへの提出 + +デプロイ後に手動で検索エンジンへ提出する必要があります： + +1. **Google Search Console** + - https://search.google.com/search-consoleにアクセス + - ウェブサイトを追加して検証 + - Sitemapを提出します: `https://weifeng2333.github.io/VideoCaptioner/sitemap.xml` + +2. **Bing Webmaster Tools** + - https://www.bing.com/webmastersにアクセス + - ウェブサイトを追加して検証 + - Sitemapを提出します + +3. **百度站長プラットフォーム** + - https://ziyuan.baidu.com/にアクセス + - ウェブサイトを追加して検証 + - Sitemapを提出します + +### SEOチェックツール + +- [Google PageSpeed Insights](https://pagespeed.web.dev/) +- [Google Rich Results Test](https://search.google.com/test/rich-results) +- [Open Graph Debugger](https://developers.facebook.com/tools/debug/) +- [Twitter Card Validator](https://cards-dev.twitter.com/validator)## 🌐 多言語サポート + +文書は中英二言語をサポートしています： + +- **中国語**：`docs/` ルートディレクトリ +- **英語**：`docs/en/` ディレクトリ + +新しい言語を追加するには： + +1. `docs/` の下に言語ディレクトリ（例： `ja/`）を作成します +2. `.vitepress/config.mts` にロケール設定を追加します +3. 文書構造をコピーし、内容を翻訳します## 🔧 テクノロジースタック + +- **VitePress**: Vite に基づく静的サイトジェネレーター +- **Vue 3**: コンポーネントベースの開発 +- **TypeScript**: タイプセーフな設定## 📝 ドキュメントの更新 + +ドキュメントの更新は GitHub Actions のデプロイを自動でトリガーします： + +1. `docs/` ディレクトリにドキュメントの変更をコミット +2. `master` または `main` ブランチにプッシュ +3. GitHub Actions が自動でビルドとデプロイを実行 +4. 約 2-3 分後に更新が反映されます## ❓ よくある質問 + +### ローカル開発時にスタイルが見えない？ + +依存関係がインストールされていることを確認してください： + +```bash +npm install +``` + +### カスタムスタイルを追加するには？ + +`docs/.vitepress/theme/` ディレクトリにカスタムテーマを作成します： + +```ts +// docs/.vitepress/theme/index.ts +import DefaultTheme from "vitepress/theme"; +import "./custom.css"; + +export default DefaultTheme; +``` + +### 検索機能を設定するには？ + +VitePressはデフォルトでローカル検索を提供しており、`config.mts`に設定されています。 + +### 画像を最適化するには？ + +1. 画像圧縮ツール（例：TinyPNG）を使用する +2. WebP形式の使用を検討する +3. `loading="lazy"`属性を追加する + +### Google Analyticsを追加するには？ + +`config.mts`の`head`に追加します： + +```typescript +([ + "script", + { + async: true, + src: "https://www.googletagmanager.com/gtag/js?id=G-XXXXXXXXXX", + }, +], + [ + "script", + {}, + ` + window.dataLayer = window.dataLayer || []; + function gtag(){dataLayer.push(arguments);} + gtag('js', new Date()); + gtag('config', 'G-XXXXXXXXXX'); +`, + ]); +``` + +--- + +VitePressの使用方法の詳細については、[公式ドキュメント](https://vitepress.dev/)を参照してください。 + +SEO最適化の詳細は、[SEO_OPTIMIZATION.md](../SEO_OPTIMIZATION.md)をご覧ください。 \ No newline at end of file diff --git a/translations/ko/README.md b/translations/ko/README.md new file mode 100644 index 00000000..340ac7c6 --- /dev/null +++ b/translations/ko/README.md @@ -0,0 +1,138 @@ +
+ VideoCaptioner Logo +

VideoCaptioner

+

대형 언어 모델 기반의 비디오 자막 처리 도구 — 음성 인식, 자막 최적화, 번역, 비디오 합성을 위한 원스톱 솔루션

+ + [온라인 문서](https://weifeng2333.github.io/VideoCaptioner/) · [CLI 사용](#cli-명령행) · [GUI 데스크탑 버전](#gui-데스크탑버전) · [Claude 코드 스킬](#claude-code-skill) +
+ +## 설치 + +```bash +pip install videocaptioner # CLI만 설치 (경량, GUI 의존성 없음) +pip install videocaptioner[gui] # CLI + GUI 데스크탑 버전 설치 +``` + +무료 기능(미剪 음성 인식, 빙/구글 번역) **설정 없이 설치 후 즉시 사용 가능**. + +## CLI 명령행 + +```bash +# 음성 전사(무료, API Key 필요 없음) +videocaptioner transcribe video.mp4 --asr bijian + +# 자막 번역(무료 빙 번역) +videocaptioner subtitle input.srt --translator bing --target-language en + +# 전체 프로세스: 전사 → 최적화 → 번역 → 합성 +videocaptioner process video.mp4 --target-language ja + +# 자막을 비디오에 통합 +videocaptioner synthesize video.mp4 -s subtitle.srt + +# 온라인 비디오 다운로드 +videocaptioner download "https://youtube.com/watch?v=xxx" +``` + +LLM 기능(자막 최적화, 대형 모델 번역)이 필요할 경우, API Key를 설정합니다: + +```bash +videocaptioner config set llm.api_key +videocaptioner config set llm.api_base https://api.openai.com/v1 +videocaptioner config set llm.model gpt-4o-mini +``` + +설정 우선순위: `명령행 인자 > 환경 변수 (VIDEOCAPTIONER_*) > 설정 파일 > 기본값`입니다. 현재 설정을 보려면 `videocaptioner config show`를 실행하세요. + +
+모든 CLI 명령 요약 + +| 명령 | 설명 | +|------|------| +| `transcribe` | 음성을 자막으로 전사. 엔진: `faster-whisper`, `whisper-api`, `bijian`(무료), `jianying`(무료), `whisper-cpp` | +| `subtitle` | 자막 최적화/번역. 번역 서비스: `llm`, `bing`(무료), `google`(무료) | +| `synthesize` | 자막을 비디오에 통합(소프트 자막/하드 자막) | +| `process` | 전체 프로세스 처리 | +| `download` | YouTube, Bilibili 등 플랫폼의 비디오 다운로드 | +| `config` | 설정 관리(`show`, `set`, `get`, `path`, `init`) | + +`videocaptioner <명령> --help`를 실행하여 전체 매개변수를 확인하세요. 전체 CLI 문서는 [docs/cli.md](docs/cli.md)를 참조하세요. + +
+ +## GUI 데스크탑 버전 + +```bash +pip install videocaptioner[gui] +videocaptioner # 매개변수 없이 실행 시 자동으로 데스크탑 버전 열기 +``` + +
+기타 설치 방법: Windows 설치 패키지 / macOS 원클릭 스크립트 + +**Windows**: [Release](https://github.com/WEIFENG2333/VideoCaptioner/releases)에서 설치 패키지를 다운로드하여 설치 + +**macOS**: +```bash +curl -fsSL https://raw.githubusercontent.com/WEIFENG2333/VideoCaptioner/master/scripts/run.sh | bash +``` + +
+ +![페이지 미리보기](https://h1.appinn.me/file/1731487410170_preview1.png) +![페이지 미리보기](https://h1.appinn.me/file/1731487410832_preview2.png) + +## LLM API 설정 + +LLM은 자막 최적화와 대형 모델 번역을 위해서만 사용되며, 무료 기능(미剪 인식, 빙 번역)은 설정이 필요하지 않습니다. + +모든 OpenAI 호환 인터페이스를 지원하는 서비스 제공업체: + +| 서비스 제공업체 | 웹사이트 | +|------------------|-----------| +| **VideoCaptioner 중계소** | [api.videocaptioner.cn](https://api.videocaptioner.cn) — 높은 동시 처리량, 가성비 우수, GPT/Claude/Gemini 등 지원 | +| SiliconCloud | [cloud.siliconflow.cn](https://cloud.siliconflow.cn/i/HF95kaoz) | +| DeepSeek | [platform.deepseek.com](https://platform.deepseek.com) | + +소프트웨어 설정 또는 CLI에서 API Base URL 및 API Key를 입력하면 됩니다. [상세 설정 가이드](https://weifeng2333.github.io/VideoCaptioner/config/llm) + +## Claude 코드 스킬 + +본 프로젝트는 [Claude 코드 스킬](https://code.claude.com/docs/en/skills.md)을 제공하여 AI 프로그래밍 도우미가 VideoCaptioner를 직접 호출하여 비디오를 처리할 수 있게 합니다. + +Claude 코드에 설치하기: + +```bash +mkdir -p ~/.claude/skills/videocaptioner +cp skills/SKILL.md ~/.claude/skills/videocaptioner/SKILL.md +``` + +그런 다음 Claude 코드에 입력하면 됩니다: `/videocaptioner transcribe video.mp4 --asr bijian`. + +## 작업 원리 + +``` +오디오 비디오 입력 → 음성 인식 → 자막 절단 → LLM 최적화 → 번역 → 비디오 합성 +``` + +- 단어 수준 타임스탬프 + VAD 음성 활동 감지, 높은 인식 정확도 +- LLM 의미 이해로 인한 자연스러운 자막 독서 경험 +- 맥락 인식 번역, 반영 최적화 메커니즘 지원 +- 배치 동시 처리, 높은 효율성 + +## 개발 + +```bash +git clone https://github.com/WEIFENG2333/VideoCaptioner.git +cd VideoCaptioner +uv sync && uv run videocaptioner # GUI 실행 +uv run videocaptioner --help # CLI 실행 +uv run pyright # 타입 검사 +uv run pytest tests/test_cli/ -q # 테스트 실행 +``` + +## 라이선스 + +[GPL-3.0](LICENSE) + +[![Star History Chart](https://api.star-history.com/svg?repos=WEIFENG2333/VideoCaptioner&type=Date)](https://star-history.com/#WEIFENG2333/VideoCaptioner&Date) \ No newline at end of file diff --git a/translations/ko/docs/README.md b/translations/ko/docs/README.md new file mode 100644 index 00000000..42ffa21d --- /dev/null +++ b/translations/ko/docs/README.md @@ -0,0 +1,245 @@ +# VideoCaptioner 문서 + +이것은 VideoCaptioner 프로젝트의 문서 원본 파일로, [VitePress](https://vitepress.dev/)를 사용하여 구축되었습니다.## 📚 온라인 보기 + +문서가 GitHub Pages에 자동으로 배포되었습니다: + +**[https://weifeng2333.github.io/VideoCaptioner/](https://weifeng2333.github.io/VideoCaptioner/)**## 🚀 로컬 개발 + +### 의존성 설치 + +```bash +npm install +``` + +### 개발 서버 시작 + +```bash +npm run docs:dev +``` + +http://localhost:5173 에서 문서 확인 + +### 문서 빌드 + +```bash +npm run docs:build +``` + +빌드 산출물은 `docs/.vitepress/dist/` 에 위치합니다. + +### 빌드 결과 미리보기 + +```bash +npm run docs:preview +```## 📁 디렉토리 구조 + +``` +docs/ +├── .vitepress/ +│ ├── config.mts # VitePress 설정 파일 (SEO 최적화 포함) +│ └── theme/ # 사용자 정의 테마 (선택 사항) +├── public/ # 정적 자원 (이미지, 로고, robots.txt) +├── guide/ # 한국어 사용 가이드 +│ ├── getting-started.md +│ ├── configuration.md +│ └── ... +├── config/ # 한국어 설정 문서 +│ ├── llm.md +│ ├── asr.md +│ └── ... +├── dev/ # 한국어 개발자 문서 +│ ├── architecture.md +│ └── ... +├── en/ # 영어 문서 (한국어 구조 미러) +│ ├── guide/ +│ ├── config/ +│ └── dev/ +└── index.md # 한국어 홈 +```## ✍️ 기여 문서 + +### 새 페이지 추가하기 + +1. 해당 디렉토리에 Markdown 파일 생성 +2. **Frontmatter SEO 최적화 추가** (중요!): + +```markdown +--- +title: 페이지 제목 - VideoCaptioner +description: 페이지 설명, 키워드 포함 +head: + - - meta + - name: keywords + content: 키워드1,키워드2,키워드3 +--- + +# 페이지 제목 + +내용... +``` + +3. `.vitepress/config.mts`의 `sidebar`에 링크 추가 +4. PR 제출 + +### 기존 페이지 편집하기 + +Markdown 파일을 직접 편집하면 됩니다, 지원 사항: + +- **Markdown 확장 문법**: 표, 코드 블록, 팝업 등 +- **Vue 컴포넌트**: Markdown 내에서 Vue 컴포넌트 사용 가능 +- **사용자 정의 컨테이너**: `::: tip`, `::: warning`, `::: danger` + +예시: + +```md +::: tip 팁 +이것은 팁 박스입니다 +::: + +::: warning 주의 +이것은 경고 박스입니다 +::: + +::: danger 위험 +이것은 위험 경고 박스입니다 +::: +``` + +### 문서 규칙 + +- **파일 이름**: 소문자와 하이픈 사용 (예: `getting-started.md`) +- **제목**: 명확한 계층 구조 사용 (# → ## → ###) +- **코드 블록**: 언어 타입을 표시하여 문법 강조 활성화 +- **이미지**: `public/` 디렉토리에 두고, `/image.png`로 참조 +- **링크**: 내부 링크는 상대 경로 사용 (예: `/guide/getting-started`) +- **SEO**: 각 페이지에 title, description 및 keywords 추가## 🔍 SEO 최적화 + +이 문서 시스템은 포괄적인 SEO 최적화를 완료하였습니다. 자세한 내용은 [SEO_OPTIMIZATION.md](../SEO_OPTIMIZATION.md)를 확인하세요. + +### 구현된 SEO 기능 + +✅ **기본 SEO** + +- Title 태그 최적화 +- Meta Description 및 Keywords +- Open Graph(소셜 미디어 카드) +- Twitter Card +- JSON-LD 구조화 데이터 +- Sitemap 자동 생성 +- robots.txt +- Canonical URL + +✅ **기술 SEO** + +- 반응형 디자인 +- Clean URLs +- 빠른 로딩(Vite 최적화) +- HTTPS(GitHub Pages) + +### 검색 엔진에 제출 + +배포 후 수동으로 검색 엔진에 제출해야 합니다: + +1. **Google Search Console** + - https://search.google.com/search-console 방문 + - 웹사이트 추가 및 검증 + - sitemap 제출: `https://weifeng2333.github.io/VideoCaptioner/sitemap.xml` + +2. **Bing Webmaster Tools** + - https://www.bing.com/webmasters 방문 + - 웹사이트 추가 및 검증 + - sitemap 제출 + +3. **바이두 웹마스터 플랫폼** + - https://ziyuan.baidu.com/ 방문 + - 웹사이트 추가 및 검증 + - sitemap 제출 + +### SEO 검사 도구 + +- [Google PageSpeed Insights](https://pagespeed.web.dev/) +- [Google Rich Results Test](https://search.google.com/test/rich-results) +- [Open Graph Debugger](https://developers.facebook.com/tools/debug/) +- [Twitter Card Validator](https://cards-dev.twitter.com/validator)## 🌐 다국어 지원 + +문서 지원 중영 이중언어： + +- **중국어**：`docs/` 루트 디렉토리 +- **영어**：`docs/en/` 디렉토리 + +새 언어 추가: + +1. `docs/` 아래에 언어 디렉토리 생성 (예: `ja/`) +2. `.vitepress/config.mts` 파일에 locale 설정 추가 +3. 문서 구조 복사하고 내용 번역## 🔧 기술 스택 + +- **VitePress**: Vite 기반의 정적 사이트 생성기 +- **Vue 3**: 컴포넌트 기반 개발 +- **TypeScript**: 타입 안전한 구성## 📝 문서 업데이트 + +문서 업데이트는 GitHub Actions 배포를 자동으로 트리거합니다: + +1. `docs/` 디렉토리에서 문서 수정 사항 제출 +2. `master` 또는 `main` 브랜치에 푸시 +3. GitHub Actions가 자동으로 빌드 및 배포 +4. 약 2-3분 후 업데이트가 적용됩니다## ❓ 자주 묻는 질문 + +### 로컬 개발 시 스타일이 보이지 않나요? + +의존성이 설치되어 있는지 확인하세요: + +```bash +npm install +``` + +### 사용자 정의 스타일을 어떻게 추가하나요? + +`docs/.vitepress/theme/` 디렉토리에 사용자 정의 테마를 생성하세요: + +```ts +// docs/.vitepress/theme/index.ts +import DefaultTheme from "vitepress/theme"; +import "./custom.css"; + +export default DefaultTheme; +``` + +### 검색 기능은 어떻게 설정하나요? + +VitePress는 기본적으로 로컬 검색을 제공하며, `config.mts`에 이미 설정되어 있습니다. + +### 이미지를 어떻게 최적화하나요? + +1. 이미지 압축 도구 사용 (예: TinyPNG) +2. WebP 형식 사용 고려 +3. `loading="lazy"` 속성 추가 + +### Google Analytics를 어떻게 추가하나요? + +`config.mts`의 `head`에 다음을 추가하세요: + +```typescript +([ + "script", + { + async: true, + src: "https://www.googletagmanager.com/gtag/js?id=G-XXXXXXXXXX", + }, +], + [ + "script", + {}, + ` + window.dataLayer = window.dataLayer || []; + function gtag(){dataLayer.push(arguments);} + gtag('js', new Date()); + gtag('config', 'G-XXXXXXXXXX'); +`, + ]); +``` + +--- + +VitePress 사용 방법에 대한 자세한 내용은 [공식 문서](https://vitepress.dev/)를 참조하세요. + +SEO 최적화에 대한 더 많은 세부정보는 [SEO_OPTIMIZATION.md](../SEO_OPTIMIZATION.md)를 확인하세요. \ No newline at end of file