@aigne/doc-smith 0.8.11-beta.5 → 0.8.11-beta.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.aigne/doc-smith/config.yaml +3 -1
- package/.aigne/doc-smith/output/structure-plan.json +2 -2
- package/.aigne/doc-smith/preferences.yml +28 -20
- package/.aigne/doc-smith/upload-cache.yaml +702 -0
- package/.release-please-manifest.json +1 -1
- package/CHANGELOG.md +22 -2
- package/README.md +2 -2
- package/agents/clear/choose-contents.mjs +2 -2
- package/agents/clear/clear-document-structure.mjs +8 -8
- package/agents/clear/index.yaml +1 -1
- package/agents/evaluate/document-structure.yaml +1 -1
- package/agents/generate/check-document-structure.yaml +3 -3
- package/agents/generate/check-need-generate-structure.mjs +8 -8
- package/agents/generate/document-structure-tools/add-document.mjs +38 -13
- package/agents/generate/document-structure-tools/delete-document.mjs +37 -14
- package/agents/generate/document-structure-tools/move-document.mjs +46 -19
- package/agents/generate/document-structure-tools/update-document.mjs +39 -12
- package/agents/generate/generate-structure.yaml +1 -1
- package/agents/generate/update-document-structure.yaml +3 -9
- package/agents/generate/user-review-document-structure.mjs +15 -14
- package/agents/translate/translate-document.yaml +1 -9
- package/agents/update/batch-generate-document.yaml +1 -1
- package/agents/update/check-document.mjs +2 -2
- package/agents/update/check-update-is-single.mjs +2 -1
- package/agents/update/document-tools/update-document-content.mjs +24 -14
- package/agents/update/fs-tools/glob.mjs +184 -0
- package/agents/update/fs-tools/grep.mjs +317 -0
- package/agents/update/fs-tools/read-file.mjs +307 -0
- package/agents/update/generate-document.yaml +4 -7
- package/agents/update/update-document-detail.yaml +6 -10
- package/agents/update/user-review-document.mjs +13 -13
- package/agents/utils/check-feedback-refiner.mjs +1 -1
- package/agents/utils/choose-docs.mjs +1 -1
- package/agents/utils/load-document-all-content.mjs +3 -3
- package/agents/utils/load-sources.mjs +1 -1
- package/agents/utils/save-docs.mjs +7 -28
- package/aigne.yaml +2 -2
- package/assets/screenshots/doc-complete-setup.png +0 -0
- package/assets/screenshots/doc-generate-docs.png +0 -0
- package/assets/screenshots/doc-generate.png +0 -0
- package/assets/screenshots/doc-generated-successfully.png +0 -0
- package/assets/screenshots/doc-publish.png +0 -0
- package/assets/screenshots/doc-regenerate.png +0 -0
- package/assets/screenshots/doc-translate-langs.png +0 -0
- package/assets/screenshots/doc-translate.png +0 -0
- package/assets/screenshots/doc-update.png +0 -0
- package/docs/_sidebar.md +1 -1
- package/docs/advanced-how-it-works.ja.md +31 -31
- package/docs/advanced-how-it-works.md +10 -10
- package/docs/advanced-how-it-works.zh-TW.md +24 -24
- package/docs/advanced-how-it-works.zh.md +20 -20
- package/docs/advanced-quality-assurance.ja.md +57 -61
- package/docs/advanced-quality-assurance.md +57 -61
- package/docs/advanced-quality-assurance.zh-TW.md +57 -61
- package/docs/advanced-quality-assurance.zh.md +57 -61
- package/docs/advanced.ja.md +8 -4
- package/docs/advanced.md +7 -3
- package/docs/advanced.zh-TW.md +9 -5
- package/docs/advanced.zh.md +9 -5
- package/docs/changelog.ja.md +206 -29
- package/docs/changelog.md +177 -0
- package/docs/changelog.zh-TW.md +229 -52
- package/docs/changelog.zh.md +204 -27
- package/docs/cli-reference.ja.md +181 -80
- package/docs/cli-reference.md +168 -67
- package/docs/cli-reference.zh-TW.md +177 -76
- package/docs/cli-reference.zh.md +172 -71
- package/docs/configuration-interactive-setup.ja.md +45 -42
- package/docs/configuration-interactive-setup.md +9 -6
- package/docs/configuration-interactive-setup.zh-TW.md +26 -23
- package/docs/configuration-interactive-setup.zh.md +25 -22
- package/docs/configuration-language-support.ja.md +33 -63
- package/docs/configuration-language-support.md +32 -62
- package/docs/configuration-language-support.zh-TW.md +35 -65
- package/docs/configuration-language-support.zh.md +32 -62
- package/docs/configuration-llm-setup.ja.md +25 -23
- package/docs/configuration-llm-setup.md +20 -18
- package/docs/configuration-llm-setup.zh-TW.md +21 -19
- package/docs/configuration-llm-setup.zh.md +20 -18
- package/docs/configuration-preferences.ja.md +67 -52
- package/docs/configuration-preferences.md +55 -40
- package/docs/configuration-preferences.zh-TW.md +69 -54
- package/docs/configuration-preferences.zh.md +68 -53
- package/docs/configuration.ja.md +98 -58
- package/docs/configuration.md +42 -2
- package/docs/configuration.zh-TW.md +86 -46
- package/docs/configuration.zh.md +76 -36
- package/docs/features-generate-documentation.ja.md +49 -55
- package/docs/features-generate-documentation.md +49 -55
- package/docs/features-generate-documentation.zh-TW.md +54 -60
- package/docs/features-generate-documentation.zh.md +48 -54
- package/docs/features-publish-your-docs.ja.md +68 -45
- package/docs/features-publish-your-docs.md +65 -42
- package/docs/features-publish-your-docs.zh-TW.md +74 -51
- package/docs/features-publish-your-docs.zh.md +67 -44
- package/docs/features-translate-documentation.ja.md +46 -35
- package/docs/features-translate-documentation.md +39 -28
- package/docs/features-translate-documentation.zh-TW.md +45 -34
- package/docs/features-translate-documentation.zh.md +39 -28
- package/docs/features-update-and-refine.ja.md +75 -71
- package/docs/features-update-and-refine.md +67 -63
- package/docs/features-update-and-refine.zh-TW.md +72 -67
- package/docs/features-update-and-refine.zh.md +71 -67
- package/docs/features.ja.md +29 -19
- package/docs/features.md +25 -15
- package/docs/features.zh-TW.md +28 -18
- package/docs/features.zh.md +31 -21
- package/docs/getting-started.ja.md +43 -46
- package/docs/getting-started.md +36 -39
- package/docs/getting-started.zh-TW.md +41 -44
- package/docs/getting-started.zh.md +39 -42
- package/docs/overview.ja.md +63 -11
- package/docs/overview.md +62 -10
- package/docs/overview.zh-TW.md +67 -15
- package/docs/overview.zh.md +62 -10
- package/docs-mcp/analyze-docs-relevance.yaml +6 -6
- package/docs-mcp/docs-search.yaml +1 -1
- package/media.md +9 -9
- package/package.json +2 -2
- package/prompts/common/document-structure/conflict-resolution-guidance.md +3 -3
- package/prompts/common/document-structure/document-structure-rules.md +2 -2
- package/prompts/detail/custom/custom-components.md +304 -188
- package/prompts/detail/document-rules.md +5 -5
- package/prompts/detail/generate-document.md +21 -8
- package/prompts/detail/update-document.md +8 -12
- package/prompts/evaluate/document-structure.md +6 -6
- package/prompts/structure/check-document-structure.md +10 -10
- package/prompts/structure/document-rules.md +2 -2
- package/prompts/structure/generate-structure-system.md +3 -3
- package/prompts/structure/structure-example.md +1 -1
- package/prompts/structure/structure-getting-started.md +1 -1
- package/prompts/structure/update-document-structure.md +18 -14
- package/prompts/utils/feedback-refiner.md +3 -3
- package/tests/agents/clear/choose-contents.test.mjs +1 -1
- package/tests/agents/clear/clear-document-structure.test.mjs +36 -30
- package/tests/agents/evaluate/generate-report.test.mjs +1 -1
- package/tests/agents/generate/check-need-generate-structure.test.mjs +1 -1
- package/tests/agents/generate/document-structure-tools/add-document.test.mjs +2 -2
- package/tests/agents/generate/document-structure-tools/delete-document.test.mjs +4 -4
- package/tests/agents/generate/document-structure-tools/move-document.test.mjs +12 -12
- package/tests/agents/generate/document-structure-tools/update-document.test.mjs +3 -3
- package/tests/agents/generate/user-review-document-structure.test.mjs +36 -13
- package/tests/agents/update/check-document.test.mjs +1 -1
- package/tests/agents/update/document-tools/update-document-content.test.mjs +115 -112
- package/tests/agents/update/fs-tools/glob.test.mjs +438 -0
- package/tests/agents/update/fs-tools/grep.test.mjs +279 -0
- package/tests/agents/update/fs-tools/read-file.test.mjs +553 -0
- package/tests/agents/update/user-review-document.test.mjs +48 -27
- package/tests/agents/utils/format-document-structure.test.mjs +5 -5
- package/tests/agents/utils/load-sources.test.mjs +4 -4
- package/tests/agents/utils/save-docs.test.mjs +1 -1
- package/tests/utils/conflict-detector.test.mjs +1 -1
- package/tests/utils/docs-finder-utils.test.mjs +8 -8
- package/types/document-schema.mjs +5 -6
- package/types/document-structure-schema.mjs +25 -13
- package/utils/conflict-detector.mjs +1 -1
- package/utils/constants/index.mjs +4 -4
- package/utils/docs-finder-utils.mjs +11 -11
- package/utils/markdown-checker.mjs +1 -1
|
@@ -1,43 +1,46 @@
|
|
|
1
1
|
# ドキュメントの翻訳
|
|
2
2
|
|
|
3
|
-
AIGNE DocSmith
|
|
3
|
+
AIGNE DocSmithは、ドキュメントを英語、中国語、スペイン語など12の異なる言語に翻訳でき、プロジェクトを世界中のオーディエンスにアクセス可能にします。このツールは、ガイド付きセットアップのための対話モードと、正確な制御と自動化のためのコマンドライン引数の2つの方法で翻訳を管理します。
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## 対話型翻訳
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
ガイド付きの体験をしたい場合は、引数なしで `translate` コマンドを実行してください。この方法は、ステップバイステップのプロセスを好むユーザーに最適です。
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
10
|
aigne doc translate
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
このコマンドは対話型ウィザードを起動し、プロセスをガイドします:
|
|
14
14
|
|
|
15
|
-
1.
|
|
15
|
+
1. **翻訳するドキュメントの選択:** 既存のドキュメントのリストが表示されます。スペースバーを使用して翻訳したいものを選択します。
|
|
16
16
|
|
|
17
|
-

|
|
18
18
|
|
|
19
|
-
2.
|
|
19
|
+
2. **ターゲット言語の選択:** ドキュメントを選択した後、サポートされているオプションのリストから1つ以上のターゲット言語を選びます。
|
|
20
20
|
|
|
21
|
-

|
|
22
22
|
|
|
23
|
-
3. **確認と実行:**DocSmithは翻訳を処理し、選択した各言語に対して選択されたファイルの新しいバージョンを生成します。
|
|
23
|
+
3. **確認と実行:** DocSmithは翻訳を処理し、選択した各言語に対して選択されたファイルの新しいバージョンを生成します。
|
|
24
24
|
|
|
25
|
-
##
|
|
25
|
+
## コマンドライン翻訳
|
|
26
26
|
|
|
27
|
-
スクリプトやCI/CD
|
|
27
|
+
スクリプトやCI/CDパイプラインでの自動化のために、コマンドラインフラグを使用して翻訳プロセスを制御します。この方法は、開発者や上級ユーザーにとってより高い柔軟性を提供します。
|
|
28
28
|
|
|
29
29
|
### コマンドパラメータ
|
|
30
30
|
|
|
31
|
-
<x-field
|
|
32
|
-
<x-field data-name="--
|
|
33
|
-
<x-field data-name="--
|
|
34
|
-
<x-field data-name="--
|
|
31
|
+
<x-field-group>
|
|
32
|
+
<x-field data-name="--langs" data-type="string" data-required="false" data-desc="ターゲット言語を1つ指定します。このフラグは複数回使用して、複数の言語を含めることができます(例:--langs zh --langs ja)。"></x-field>
|
|
33
|
+
<x-field data-name="--docs" data-type="string" data-required="false" data-desc="翻訳するドキュメントのパスを指定します。これもバッチ翻訳のために複数回使用できます。"></x-field>
|
|
34
|
+
<x-field data-name="--feedback" data-type="string" data-required="false" data-desc="AIに提案を提供して翻訳品質をガイドします(例:--feedback "フォーマルなトーンを使用してください")。"></x-field>
|
|
35
|
+
<x-field data-name="--glossary" data-type="string" data-required="false" data-desc="Markdown形式の用語集ファイルを使用して、特定の用語の一貫性を確保します(例:--glossary @path/to/glossary.md)。"></x-field>
|
|
36
|
+
<x-field data-name="--model" data-type="string" data-required="false" data-desc="使用する翻訳モデルを指定します。例:'openai:gpt-4o' または 'google:gemini-2.5-pro'。"></x-field>
|
|
37
|
+
</x-field-group>
|
|
35
38
|
|
|
36
39
|
### 例
|
|
37
40
|
|
|
38
41
|
#### 特定のドキュメントの翻訳
|
|
39
42
|
|
|
40
|
-
`overview.md
|
|
43
|
+
`overview.md` と `examples.md` を中国語と日本語に翻訳するには、次のコマンドを実行します:
|
|
41
44
|
|
|
42
45
|
```bash
|
|
43
46
|
aigne doc translate --langs zh --langs ja --docs overview.md --docs examples.md
|
|
@@ -45,35 +48,43 @@ aigne doc translate --langs zh --langs ja --docs overview.md --docs examples.md
|
|
|
45
48
|
|
|
46
49
|
#### 用語集とフィードバックの使用
|
|
47
50
|
|
|
48
|
-
|
|
51
|
+
ブランド名や技術用語が正しく翻訳されるように、用語集ファイルを提供できます。また、翻訳スタイルを洗練させるためのフィードバックも提供できます。
|
|
49
52
|
|
|
50
53
|
```bash
|
|
51
|
-
aigne doc translate --glossary @glossary.md --feedback "Use technical terminology consistently" --docs overview.md --langs de
|
|
54
|
+
aigne doc translate --glossary @path/to/glossary.md --feedback "Use technical terminology consistently" --docs overview.md --langs de
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
#### 翻訳モデルの指定
|
|
58
|
+
|
|
59
|
+
翻訳タスクに特定のAIモデルを使用するには、`--model` フラグを使用します。
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
aigne doc translate --docs overview.md --langs fr --model openai:gpt-4o
|
|
52
63
|
```
|
|
53
64
|
|
|
54
65
|
## サポートされている言語
|
|
55
66
|
|
|
56
|
-
DocSmith
|
|
57
|
-
|
|
58
|
-
|
|
|
59
|
-
|
|
60
|
-
| 英語
|
|
61
|
-
| 簡体字中国語
|
|
62
|
-
| 繁体字中国語
|
|
63
|
-
| 日本語
|
|
64
|
-
| 韓国語
|
|
65
|
-
| スペイン語
|
|
66
|
-
| フランス語
|
|
67
|
-
| ドイツ語
|
|
68
|
-
| ポルトガル語
|
|
69
|
-
| ロシア語
|
|
70
|
-
| イタリア語
|
|
71
|
-
| アラビア語
|
|
67
|
+
DocSmithは、以下の12言語の自動翻訳をサポートしています:
|
|
68
|
+
|
|
69
|
+
| 言語 | コード |
|
|
70
|
+
| -------------------- | ------- |
|
|
71
|
+
| 英語 | `en` |
|
|
72
|
+
| 簡体字中国語 | `zh-CN` |
|
|
73
|
+
| 繁体字中国語 | `zh-TW` |
|
|
74
|
+
| 日本語 | `ja` |
|
|
75
|
+
| 韓国語 | `ko` |
|
|
76
|
+
| スペイン語 | `es` |
|
|
77
|
+
| フランス語 | `fr` |
|
|
78
|
+
| ドイツ語 | `de` |
|
|
79
|
+
| ポルトガル語 | `pt-BR` |
|
|
80
|
+
| ロシア語 | `ru` |
|
|
81
|
+
| イタリア語 | `it` |
|
|
82
|
+
| アラビア語 | `ar` |
|
|
72
83
|
|
|
73
84
|
---
|
|
74
85
|
|
|
75
86
|
ドキュメントが翻訳されたら、世界と共有する準備が整いました。
|
|
76
87
|
|
|
77
88
|
<x-card data-title="次へ:ドキュメントの公開" data-icon="lucide:upload-cloud" data-href="/features/publish-your-docs" data-cta="続きを読む">
|
|
78
|
-
|
|
89
|
+
ドキュメントを公開プラットフォームや独自のプライベートウェブサイトに簡単に公開する方法についてのガイド。
|
|
79
90
|
</x-card>
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
# Translate Documentation
|
|
2
2
|
|
|
3
|
-
AIGNE DocSmith can translate your documentation into 12 different languages, making your project accessible to a global audience. The tool provides two ways to manage translations: an interactive mode for a guided setup and command-line arguments for precise control and automation.
|
|
3
|
+
AIGNE DocSmith can translate your documentation into 12 different languages, including English, Chinese, and Spanish, making your project accessible to a global audience. The tool provides two ways to manage translations: an interactive mode for a guided setup and command-line arguments for precise control and automation.
|
|
4
4
|
|
|
5
5
|
## Interactive Translation
|
|
6
6
|
|
|
7
|
-
For a guided experience, run the `translate` command without any arguments. This is ideal for users who prefer a step-by-step process.
|
|
7
|
+
For a guided experience, run the `translate` command without any arguments. This method is ideal for users who prefer a step-by-step process.
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
10
|
aigne doc translate
|
|
@@ -14,30 +14,33 @@ This command launches an interactive wizard that guides you through the process:
|
|
|
14
14
|
|
|
15
15
|
1. **Select Documents to Translate:** You will be presented with a list of your existing documents. Use the spacebar to select the ones you want to translate.
|
|
16
16
|
|
|
17
|
-

|
|
18
18
|
|
|
19
19
|
2. **Choose Target Languages:** After selecting your documents, pick one or more target languages from the list of supported options.
|
|
20
20
|
|
|
21
|
-

|
|
22
22
|
|
|
23
23
|
3. **Confirm and Run:** DocSmith will then process the translation, generating new versions of your selected files for each chosen language.
|
|
24
24
|
|
|
25
25
|
## Command-Line Translation
|
|
26
26
|
|
|
27
|
-
For automation in scripts or CI/CD pipelines, use command-line flags to control the translation process. This method
|
|
27
|
+
For automation in scripts or CI/CD pipelines, use command-line flags to control the translation process. This method provides greater flexibility for developers and advanced users.
|
|
28
28
|
|
|
29
29
|
### Command Parameters
|
|
30
30
|
|
|
31
|
-
<x-field
|
|
32
|
-
<x-field data-name="--
|
|
33
|
-
<x-field data-name="--
|
|
34
|
-
<x-field data-name="--
|
|
31
|
+
<x-field-group>
|
|
32
|
+
<x-field data-name="--langs" data-type="string" data-required="false" data-desc="Specify one target language. This flag can be used multiple times to include several languages (e.g., --langs zh --langs ja)."></x-field>
|
|
33
|
+
<x-field data-name="--docs" data-type="string" data-required="false" data-desc="Specify the path of a document to translate. This can also be used multiple times for batch translation."></x-field>
|
|
34
|
+
<x-field data-name="--feedback" data-type="string" data-required="false" data-desc="Provide suggestions to the AI to guide the translation quality (e.g., --feedback "Use a formal tone")."></x-field>
|
|
35
|
+
<x-field data-name="--glossary" data-type="string" data-required="false" data-desc="Use a glossary file in Markdown format to ensure consistent terminology for specific terms (e.g., --glossary @path/to/glossary.md)."></x-field>
|
|
36
|
+
<x-field data-name="--model" data-type="string" data-required="false" data-desc="Specify the translation model to use, for example, 'openai:gpt-4o' or 'google:gemini-2.5-pro'."></x-field>
|
|
37
|
+
</x-field-group>
|
|
35
38
|
|
|
36
39
|
### Examples
|
|
37
40
|
|
|
38
41
|
#### Translating Specific Documents
|
|
39
42
|
|
|
40
|
-
To translate `overview.md` and `examples.md` into Chinese and Japanese, run:
|
|
43
|
+
To translate `overview.md` and `examples.md` into Chinese and Japanese, run the following command:
|
|
41
44
|
|
|
42
45
|
```bash
|
|
43
46
|
aigne doc translate --langs zh --langs ja --docs overview.md --docs examples.md
|
|
@@ -48,32 +51,40 @@ aigne doc translate --langs zh --langs ja --docs overview.md --docs examples.md
|
|
|
48
51
|
To ensure brand names and technical terms are translated correctly, you can provide a glossary file. You can also give feedback to refine the translation style.
|
|
49
52
|
|
|
50
53
|
```bash
|
|
51
|
-
aigne doc translate --glossary @glossary.md --feedback "Use technical terminology consistently" --docs overview.md --langs de
|
|
54
|
+
aigne doc translate --glossary @path/to/glossary.md --feedback "Use technical terminology consistently" --docs overview.md --langs de
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
#### Specifying a Translation Model
|
|
58
|
+
|
|
59
|
+
To use a specific AI model for the translation task, use the `--model` flag.
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
aigne doc translate --docs overview.md --langs fr --model openai:gpt-4o
|
|
52
63
|
```
|
|
53
64
|
|
|
54
65
|
## Supported Languages
|
|
55
66
|
|
|
56
|
-
DocSmith supports automatic translation for the following languages:
|
|
57
|
-
|
|
58
|
-
| Language
|
|
59
|
-
|
|
60
|
-
| English
|
|
61
|
-
| Simplified Chinese
|
|
62
|
-
| Traditional Chinese
|
|
63
|
-
| Japanese
|
|
64
|
-
| Korean
|
|
65
|
-
| Spanish
|
|
66
|
-
| French
|
|
67
|
-
| German
|
|
68
|
-
| Portuguese
|
|
69
|
-
| Russian
|
|
70
|
-
| Italian
|
|
71
|
-
| Arabic
|
|
67
|
+
DocSmith supports automatic translation for the following 12 languages:
|
|
68
|
+
|
|
69
|
+
| Language | Code |
|
|
70
|
+
| -------------------- | ------- |
|
|
71
|
+
| English | `en` |
|
|
72
|
+
| Simplified Chinese | `zh-CN` |
|
|
73
|
+
| Traditional Chinese | `zh-TW` |
|
|
74
|
+
| Japanese | `ja` |
|
|
75
|
+
| Korean | `ko` |
|
|
76
|
+
| Spanish | `es` |
|
|
77
|
+
| French | `fr` |
|
|
78
|
+
| German | `de` |
|
|
79
|
+
| Portuguese | `pt-BR` |
|
|
80
|
+
| Russian | `ru` |
|
|
81
|
+
| Italian | `it` |
|
|
82
|
+
| Arabic | `ar` |
|
|
72
83
|
|
|
73
84
|
---
|
|
74
85
|
|
|
75
86
|
Once your documentation is translated, you are ready to share it with the world.
|
|
76
87
|
|
|
77
88
|
<x-card data-title="Next: Publish Your Docs" data-icon="lucide:upload-cloud" data-href="/features/publish-your-docs" data-cta="Read More">
|
|
78
|
-
A guide on how to publish your documentation to a public platform or your own private website.
|
|
89
|
+
A guide on how to easily publish your documentation to a public platform or your own private website.
|
|
79
90
|
</x-card>
|
|
@@ -1,43 +1,46 @@
|
|
|
1
1
|
# 翻譯文件
|
|
2
2
|
|
|
3
|
-
AIGNE DocSmith 可以將您的文件翻譯成 12
|
|
3
|
+
AIGNE DocSmith 可以將您的文件翻譯成 12 種不同的語言,包括英文、中文和西班牙文,讓您的專案能觸及全球受眾。該工具提供兩種管理翻譯的方式:用於引導式設定的互動模式,以及用於精確控制和自動化的命令列參數。
|
|
4
4
|
|
|
5
5
|
## 互動式翻譯
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
若要獲得引導式體驗,請執行不含任何參數的 `translate` 命令。此方法非常適合偏好逐步操作的使用者。
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
10
|
aigne doc translate
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
此命令會啟動一個互動式精靈,引導您完成整個過程:
|
|
14
14
|
|
|
15
|
-
1.
|
|
15
|
+
1. **選擇要翻譯的文件:** 系統會顯示您現有文件的列表。使用空格鍵選擇您要翻譯的文件。
|
|
16
16
|
|
|
17
|
-

|
|
18
18
|
|
|
19
|
-
2. **選擇目標語言:**
|
|
19
|
+
2. **選擇目標語言:** 選擇文件後,從支援的選項列表中選擇一種或多種目標語言。
|
|
20
20
|
|
|
21
|
-

|
|
22
22
|
|
|
23
|
-
3. **確認並執行:**
|
|
23
|
+
3. **確認並執行:** DocSmith 隨後會處理翻譯,為您選擇的每個檔案生成對應各種語言的新版本。
|
|
24
24
|
|
|
25
25
|
## 命令列翻譯
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
對於在腳本或 CI/CD 流程中進行自動化,請使用命令列旗標來控制翻譯過程。此方法為開發人員和進階使用者提供了更大的靈活性。
|
|
28
28
|
|
|
29
|
-
###
|
|
29
|
+
### 命令參數
|
|
30
30
|
|
|
31
|
-
<x-field
|
|
32
|
-
<x-field data-name="--
|
|
33
|
-
<x-field data-name="--
|
|
34
|
-
<x-field data-name="--
|
|
31
|
+
<x-field-group>
|
|
32
|
+
<x-field data-name="--langs" data-type="string" data-required="false" data-desc="指定一種目標語言。此旗標可多次使用以包含多種語言(例如,--langs zh --langs ja)。"></x-field>
|
|
33
|
+
<x-field data-name="--docs" data-type="string" data-required="false" data-desc="指定要翻譯的文件路徑。此旗標也可多次使用以進行批次翻譯。"></x-field>
|
|
34
|
+
<x-field data-name="--feedback" data-type="string" data-required="false" data-desc="向 AI 提供建議以引導翻譯品質(例如,--feedback "使用正式語氣")。"></x-field>
|
|
35
|
+
<x-field data-name="--glossary" data-type="string" data-required="false" data-desc="使用 Markdown 格式的詞彙表檔案,以確保特定術語的一致性(例如,--glossary @path/to/glossary.md)。"></x-field>
|
|
36
|
+
<x-field data-name="--model" data-type="string" data-required="false" data-desc="指定要使用的翻譯模型,例如 'openai:gpt-4o' 或 'google:gemini-2.5-pro'。"></x-field>
|
|
37
|
+
</x-field-group>
|
|
35
38
|
|
|
36
39
|
### 範例
|
|
37
40
|
|
|
38
41
|
#### 翻譯特定文件
|
|
39
42
|
|
|
40
|
-
若要將 `overview.md` 和 `examples.md`
|
|
43
|
+
若要將 `overview.md` 和 `examples.md` 翻譯成中文和日文,請執行以下命令:
|
|
41
44
|
|
|
42
45
|
```bash
|
|
43
46
|
aigne doc translate --langs zh --langs ja --docs overview.md --docs examples.md
|
|
@@ -48,32 +51,40 @@ aigne doc translate --langs zh --langs ja --docs overview.md --docs examples.md
|
|
|
48
51
|
為確保品牌名稱和技術術語翻譯正確,您可以提供一個詞彙表檔案。您也可以提供回饋來改善翻譯風格。
|
|
49
52
|
|
|
50
53
|
```bash
|
|
51
|
-
aigne doc translate --glossary @glossary.md --feedback "Use technical terminology consistently" --docs overview.md --langs de
|
|
54
|
+
aigne doc translate --glossary @path/to/glossary.md --feedback "Use technical terminology consistently" --docs overview.md --langs de
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
#### 指定翻譯模型
|
|
58
|
+
|
|
59
|
+
若要使用特定的 AI 模型執行翻譯任務,請使用 `--model` 旗標。
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
aigne doc translate --docs overview.md --langs fr --model openai:gpt-4o
|
|
52
63
|
```
|
|
53
64
|
|
|
54
65
|
## 支援的語言
|
|
55
66
|
|
|
56
|
-
DocSmith
|
|
57
|
-
|
|
58
|
-
| 語言
|
|
59
|
-
|
|
60
|
-
| 英文
|
|
61
|
-
| 簡體中文
|
|
62
|
-
| 繁體中文
|
|
63
|
-
| 日文
|
|
64
|
-
| 韓文
|
|
65
|
-
| 西班牙文
|
|
66
|
-
| 法文
|
|
67
|
-
| 德文
|
|
68
|
-
| 葡萄牙文
|
|
69
|
-
| 俄文
|
|
70
|
-
| 義大利文
|
|
71
|
-
| 阿拉伯文
|
|
67
|
+
DocSmith 支援以下 12 種語言的自動翻譯:
|
|
68
|
+
|
|
69
|
+
| 語言 | 代碼 |
|
|
70
|
+
| -------------------- | ------- |
|
|
71
|
+
| 英文 | `en` |
|
|
72
|
+
| 簡體中文 | `zh-CN` |
|
|
73
|
+
| 繁體中文 | `zh-TW` |
|
|
74
|
+
| 日文 | `ja` |
|
|
75
|
+
| 韓文 | `ko` |
|
|
76
|
+
| 西班牙文 | `es` |
|
|
77
|
+
| 法文 | `fr` |
|
|
78
|
+
| 德文 | `de` |
|
|
79
|
+
| 葡萄牙文 | `pt-BR` |
|
|
80
|
+
| 俄文 | `ru` |
|
|
81
|
+
| 義大利文 | `it` |
|
|
82
|
+
| 阿拉伯文 | `ar` |
|
|
72
83
|
|
|
73
84
|
---
|
|
74
85
|
|
|
75
|
-
|
|
86
|
+
文件翻譯完成後,您就可以與全世界分享了。
|
|
76
87
|
|
|
77
88
|
<x-card data-title="下一步:發佈您的文件" data-icon="lucide:upload-cloud" data-href="/features/publish-your-docs" data-cta="閱讀更多">
|
|
78
|
-
|
|
89
|
+
關於如何輕鬆將您的文件發佈到公共平台或您自己的私人網站的指南。
|
|
79
90
|
</x-card>
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
# 翻译文档
|
|
2
2
|
|
|
3
|
-
AIGNE DocSmith 可以将您的文档翻译成 12
|
|
3
|
+
AIGNE DocSmith 可以将您的文档翻译成 12 种不同的语言,包括英语、中文和西班牙语,让您的项目触达全球受众。该工具提供两种管理翻译的方式:用于引导式设置的交互模式和用于精确控制和自动化的命令行参数。
|
|
4
4
|
|
|
5
5
|
## 交互式翻译
|
|
6
6
|
|
|
7
|
-
|
|
7
|
+
要获得引导式体验,请在不带任何参数的情况下运行 `translate` 命令。此方法非常适合偏好分步操作的用户。
|
|
8
8
|
|
|
9
9
|
```bash
|
|
10
10
|
aigne doc translate
|
|
@@ -14,30 +14,33 @@ aigne doc translate
|
|
|
14
14
|
|
|
15
15
|
1. **选择要翻译的文档:** 您将看到一个现有文档的列表。使用空格键选择您想要翻译的文档。
|
|
16
16
|
|
|
17
|
-

|
|
18
18
|
|
|
19
19
|
2. **选择目标语言:** 选择文档后,从支持的选项列表中选择一种或多种目标语言。
|
|
20
20
|
|
|
21
|
-

|
|
22
22
|
|
|
23
23
|
3. **确认并运行:** DocSmith 随后将处理翻译,为每个选定的语言生成所选文件的新版本。
|
|
24
24
|
|
|
25
25
|
## 命令行翻译
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
要在脚本或 CI/CD 管道中实现自动化,请使用命令行标志来控制翻译过程。此方法为开发人员和高级用户提供了更大的灵活性。
|
|
28
28
|
|
|
29
29
|
### 命令参数
|
|
30
30
|
|
|
31
|
-
<x-field
|
|
32
|
-
<x-field data-name="--
|
|
33
|
-
<x-field data-name="--
|
|
34
|
-
<x-field data-name="--
|
|
31
|
+
<x-field-group>
|
|
32
|
+
<x-field data-name="--langs" data-type="string" data-required="false" data-desc="指定一个目标语言。此标志可以多次使用以包含多种语言(例如,--langs zh --langs ja)。"></x-field>
|
|
33
|
+
<x-field data-name="--docs" data-type="string" data-required="false" data-desc="指定要翻译的文档路径。此标志也可以多次使用以进行批量翻译。"></x-field>
|
|
34
|
+
<x-field data-name="--feedback" data-type="string" data-required="false" data-desc="向 AI 提供建议以指导翻译质量(例如,--feedback "使用正式语气")。"></x-field>
|
|
35
|
+
<x-field data-name="--glossary" data-type="string" data-required="false" data-desc="使用 Markdown 格式的术语表文件,以确保特定术语的用词一致(例如,--glossary @path/to/glossary.md)。"></x-field>
|
|
36
|
+
<x-field data-name="--model" data-type="string" data-required="false" data-desc="指定要使用的翻译模型,例如 'openai:gpt-4o' 或 'google:gemini-2.5-pro'。"></x-field>
|
|
37
|
+
</x-field-group>
|
|
35
38
|
|
|
36
39
|
### 示例
|
|
37
40
|
|
|
38
41
|
#### 翻译特定文档
|
|
39
42
|
|
|
40
|
-
要将 `overview.md` 和 `examples.md`
|
|
43
|
+
要将 `overview.md` 和 `examples.md` 翻译成中文和日文,请运行以下命令:
|
|
41
44
|
|
|
42
45
|
```bash
|
|
43
46
|
aigne doc translate --langs zh --langs ja --docs overview.md --docs examples.md
|
|
@@ -45,35 +48,43 @@ aigne doc translate --langs zh --langs ja --docs overview.md --docs examples.md
|
|
|
45
48
|
|
|
46
49
|
#### 使用术语表和反馈
|
|
47
50
|
|
|
48
|
-
|
|
51
|
+
为确保品牌名称和技术术语翻译正确,您可以提供一个术语表文件。您还可以提供反馈以改进翻译风格。
|
|
49
52
|
|
|
50
53
|
```bash
|
|
51
|
-
aigne doc translate --glossary @glossary.md --feedback "Use technical terminology consistently" --docs overview.md --langs de
|
|
54
|
+
aigne doc translate --glossary @path/to/glossary.md --feedback "Use technical terminology consistently" --docs overview.md --langs de
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
#### 指定翻译模型
|
|
58
|
+
|
|
59
|
+
要使用特定的 AI 模型执行翻译任务,请使用 `--model` 标志。
|
|
60
|
+
|
|
61
|
+
```bash
|
|
62
|
+
aigne doc translate --docs overview.md --langs fr --model openai:gpt-4o
|
|
52
63
|
```
|
|
53
64
|
|
|
54
65
|
## 支持的语言
|
|
55
66
|
|
|
56
|
-
DocSmith
|
|
67
|
+
DocSmith 支持以下 12 种语言的自动翻译:
|
|
57
68
|
|
|
58
69
|
| 语言 | 代码 |
|
|
59
|
-
|
|
60
|
-
| 英语 | en |
|
|
61
|
-
| 简体中文 | zh-CN |
|
|
62
|
-
| 繁体中文 | zh-TW |
|
|
63
|
-
| 日语 | ja |
|
|
64
|
-
| 韩语 | ko |
|
|
65
|
-
| 西班牙语 | es |
|
|
66
|
-
| 法语 | fr |
|
|
67
|
-
| 德语 | de |
|
|
68
|
-
| 葡萄牙语 | pt-BR |
|
|
69
|
-
| 俄语 | ru |
|
|
70
|
-
| 意大利语 | it |
|
|
71
|
-
| 阿拉伯语 | ar |
|
|
70
|
+
| -------------------- | ------- |
|
|
71
|
+
| 英语 | `en` |
|
|
72
|
+
| 简体中文 | `zh-CN` |
|
|
73
|
+
| 繁体中文 | `zh-TW` |
|
|
74
|
+
| 日语 | `ja` |
|
|
75
|
+
| 韩语 | `ko` |
|
|
76
|
+
| 西班牙语 | `es` |
|
|
77
|
+
| 法语 | `fr` |
|
|
78
|
+
| 德语 | `de` |
|
|
79
|
+
| 葡萄牙语 | `pt-BR` |
|
|
80
|
+
| 俄语 | `ru` |
|
|
81
|
+
| 意大利语 | `it` |
|
|
82
|
+
| 阿拉伯语 | `ar` |
|
|
72
83
|
|
|
73
84
|
---
|
|
74
85
|
|
|
75
|
-
|
|
86
|
+
文档翻译完成后,您就可以与全世界分享了。
|
|
76
87
|
|
|
77
88
|
<x-card data-title="下一步:发布您的文档" data-icon="lucide:upload-cloud" data-href="/features/publish-your-docs" data-cta="阅读更多">
|
|
78
|
-
|
|
89
|
+
一份关于如何轻松将您的文档发布到公共平台或您自己的私人网站的指南。
|
|
79
90
|
</x-card>
|