Pierre
6.1 KiB
ترجمه خودکار مستندات OpenAI
en| zh-Hans | es | ru | de | fr | ja | ko | pt | it | ar | tr | pl | nl | vi | th | ro | sv | hu | cs | el | da | fi | he | no | hi | zh_tw | in | sl | se | sk | uk | bg | hr | lt | lv | et | cat
این مستند به طور خودکار ترجمه شده و ممکن است حاوی اشتباهات باشد. در صورت پیشنهاد تغییرات، دریغ نکنید از باز کردن یک Pull Request.
نصب
این ابزار می تواند از طریق NPM نصب شود:
npm install -g autotranslatedoc
مطمئن شوید که متغیرهای محیطی GITHUB_PERSONAL_ACCESS_TOKEN و OPENAI_API_KEY را تنظیم کرده اید. به طور جایگزین، این توکن ها می توانند به عنوان پارامترها منتقل شوند. برای کسب اطلاعات بیشتر، به مستندات GitHub مراجعه کنید تا یک GITHUB_PERSONAL_ACCESS_TOKEN دریافت کنید.
استفاده
صفحه راهنما
برای دسترسی به صفحه راهنما، از دستور زیر استفاده کنید:
autotranslatedoc -h
ترجمه مستندات
Autotranslatedoc 3 آرگومان و بسیاری از گزینه ها را می پذیرد
autotranslatedoc <command> <repo_org> <repo_name> (options)
commandمی تواند یکی از موارد زیر باشد:translate(برای ترجمه)،update(برای به روزرسانی ترجمه)،build(برای ساخت ترجمه)repo_orgسازمان مخزن مورد نظر در GitHub استrepo_nameنام مخزن مورد نظر در GitHub است
گزینه های اصلی موجود عبارتند از:
--language <lang_1>(, <lang_2>)*(یا-l) برای انتخاب زبانی که می خواهید به آن ترجمه کنید.--docPath </url/path>(یا-d) برای محدود کردن ترجمه به فایل های موجود در یک مسیر خاص.--savePath <./localPath>(یا-s) برای انتخاب مسیری که فایل ذخیره شده در آن ذخیره می شود (به صورت پیش فرض./saveاست).--outputPath <./localPath>(یا-o) هنگام استفاده ازbuild، برای مشخص کردن مکانی که فایل های مستند ترجمه شده در آن خروجی داده می شوند (به صورت پیش فرض./buildاست).
برای ترجمه مستندات یک مخزن مورد نظر به زبان فرانسوی و اسپانیایی، از دستور زیر استفاده کنید:
autotranslatedoc translate run-llama llama_index -l fr,es
این دستور یک فایل llama_index.json در دایرکتوری run-lama در مسیر خروجی مشخص شده ایجاد می کند (به صورت پیش فرض ./save است).
ls ./save
run-llama
llama_index.json
فایل ذخیره شده شامل تمام ترجمه ها است و می تواند برای تولید مستندات در یک فرمت مقصد (فقط .md در حال حاضر) استفاده شود.
برای ساخت مستندات ترجمه شده، از دستور زیر استفاده کنید:
autotranslatedoc build run-llama llama_index -l fr,es
این دستور دایرکتوری های fr و es را در buildPath (به صورت پیش فرض ./build) ایجاد می کند که حاوی فایل های مستندات ترجمه شده است.
برای به روزرسانی مستندات ترجمه شده بر اساس تغییرات در فایل های اصلی، از دستور زیر استفاده کنید:
autotranslatedoc update run-llama llama_index -l fr,es
برای مشاهده مستندات از طریق یک سرور (ویژگی آزمایشی)، از دستور زیر استفاده کنید:
autotranslatedoc serve run-llama llama_index
ترجمه مستندات Docusaurus
برای ترجمه مستندات میزبان شده در Docusaurus، از دستور زیر استفاده کنید:
autotranslatedoc translate run-llama LlamaIndexTS --docPath /apps/docs/docs -l fr,es -m docusaurus
autotranslatedoc build run-llama LlamaIndexTS --docPath /apps/docs/docs -l fr,es -m docusaurus
ترجمه فقط فایل README.md
برای ترجمه فقط فایل README، از حالت readme استفاده کنید:
autotranslatedoc translate run-llama LlamaIndexTS -l fr,es -m readme
autotranslatedoc build run-llama LlamaIndexTS -l fr,es -m readme
ترجمه به تمام زبان های پشتیبانی شده
برای ترجمه به تمام زبان های پشتیبانی شده، از گزینه -l all استفاده کنید:
autotranslatedoc translate run-llama LlamaIndexTS -l all -m readme
autotranslatedoc build run-llama LlamaIndexTS -l all -m readme
مشکلات شناخته شده
در حال حاضر، ترجمه با -all فقط از انگلیسی به سایر زبان ها پشتیبانی می شود.