Skip to content

CLI — ドキュメント ​

translate-docs ​

概要: ai-i18n-tools translate-docs [options]

markdown、MDX、.astro、オプションのDocusaurusカタログJSON(docusaurusCatalogDir)、オプションのNextra _meta.ts/辞書.ts、および各docsブロックのオプションのVitePressテーマカタログを翻訳します。

主なオプション: -l, -j, -b, --prompt-format, --force, --force-update, --check-cache, -p / -f, --dry-run

-j: 最大並列ロケール数。-b: ファイルあたりの最大並列バッチAPI呼び出し数。--prompt-format: バッチワイヤーフォーマット(xml | json-array | json-object)。

関連項目: キャッシュの動作とtranslate-docsフラグ、バッチプロンプトフォーマット


write-heading-ids ​

概要: ai-i18n-tools write-heading-ids [options]

少なくとも1つのdocs[]ブロックが必要です。各ブロックのcontentPaths配下の.md / .mdxを収集します(.translate-ignoreを尊重)。デフォルトでは、フラットなATX #見出しの直前にHTMLアンカー行<a id="slug"></a>を挿入します(フェンスされたコードブロック内の見出しはスキップ)。任意の形式の既存の見出しID(HTMLアンカー行、従来の{#id}サフィックス、MDX {/* #id */}コメント)は選択したスタイルに置き換えられます。スラッグは常に現在の見出しテキストから生成されます。--slug-style mdx-commentを指定すると、代わりに見出し行にDocusaurus MDXコメントサフィックスを書き込みます(同じgithubスタイルのスラッグアルゴリズム)。先行するHTMLアンカーが存在する場合は削除します。--removeはこれらすべての見出しID形式を削除し、代わりに何も書き込みません。

ソースファイルの更新後、コマンドは各ロケールの既存の翻訳済みマークダウンも走査します(translate-docsと同じdocsOutputパスマッピング)。ドキュメントの順序で一致するATX見出しに英語の見出しIDをコピーします(翻訳されたタイトルのスラッグ化は決して行いません)。また、見出し途中の{#id} / {/* #id */}(または孤立したHTML <a id>)をDocusaurusまたは選択したスタイルが期待する形式に戻します。翻訳済みファイルが欠落している場合はスキップされます。--removeは、不適切な位置にある行内のトークンを含め、それらの翻訳済みファイルからも見出しIDを削除します。

翻訳済みファイルの見出しIDが再配置または修復されると、英語ソースと新旧の翻訳コンテンツのセグメント数が一致している場合に限り、対応するキャッシュ済み翻訳セグメント(英語ソースハッシュをキーとする)も更新されます。セグメント数が一致しない場合は、そのファイルとロケールはスキップされます。その後、sync --force-updateによって更新されたキャッシュ行からファイルが再構築されます。

主なオプション: -p / --path、-f / --file、--slug-style、--remove、--dry-run

--slug-style: github(デフォルト、doctoc / anchor-markdown-header)、bitbucket、gitlab、pymdown、azure-devops、mdx-comment(Docusaurus {/* #… */}サフィックス)。pymdown、オプションの--pymdown-case、--pymdown-normalize、--pymdown-percent-encode / --no-pymdown-percent-encode。--removeは--pymdown-*と組み合わせることはできません。

関連項目: アンカーリンク


check-markdown ​

概要: ai-i18n-tools check-markdown [options]

各docs[]ブロックのcontentPaths配下のmarkdown/MDXをスキャンします(translate-docsと同じ検出方法、.translate-ignoreを考慮):デリミタのペアリング、未閉じのインラインコード、および**/__が[text](url)リンクを囲む場合のSTRONG_OUTSIDE_LINK。

relativePath:line: [ISSUE_CODE] message行をstderrに出力します。問題がある場合は終了コード1。--json: stdoutにJSONレポートを出力します。--no-cacheがない限り、cacheDirにmarkdown_source_issuesを書き込みます。-vはstderr行にソースハッシュを追加します。

主なオプション: -p / --path、-f / --file、--json、--no-cache

関連項目: Markdownの問題

MITライセンスの下で公開されています。