ترجمه مستندات GitHub Readme Stats

ترجمه مستندات GitHub Readme Stats

آمارهای گیت هاب خود را به صورت داینامیک و پویا در READMEها نمایش دهید.

نمایش دمو · گزارش خطا · پیشنهاد قابلیت جدید

Français · 简体中文 · Español · Deutsch · 日本語 · Português Brasileiro · Italiano · 한국어 . Nederlands . नेपाली . Türkçe . فارسی

اگر این پروژه را دوست دارید از این پروژه حمایت مالی کنید تا به بهتر شدن پروژه کمک کرده باشید.

دوست دارید از این پروژه حمایت کنید؟! صبر کنید اینکار را نکنید.

در عوض به کشور هندوستان برای مقابله با پاندمی کرونا یا کووید19 کمک کنید؛ امکانات درمانی و اکسیژن در این کشور برای مقابله با بیماری کافی نیست.

این لینک را ببینید https://indiafightscorona.giveindia.org و یک کمک حتی کوچک برای کنترل این بیماری داشته باشید. ❤️

لینک مستندات فارسی در گیت هاب من :

https://github.com/amirshnll/github-readme-stats/blob/master/docs/readme_fa.md

لینک مستندات فارسی در پروژه اصلی :

https://github.com/anuraghazra/github-readme-stats/blob/master/docs/readme_fa.md

ترجمه مستندات GitHub Readme Stats

کارت آمارهای گیت هاب

به سادگی کدهای زیر را کپی پیست کنید و از آن ها استفاده کنید.

کافیست فقط ?username= را با مقدار نام کاربری خودتون تغییر بدین.

نکته : نمره ی S+ به معنی 1 درصد بهترین، نمره ی S به معنی 25 درصد بهترین، نمره ی A++ به معنی 45 درصد بهترین، نمره ی A+ به معنی 60 درصد بهترین، و نمره ی B+ برای همه می باشد.

مقدار ها با استفاده از تابع توزیع تجمعی محاسبه می شود و در آن ها از مواردی شامل تعداد کامیت ها، مشارکت های شما، گزارش های خطا یا issueها، ستاره های شما، forkهای شما و پروژه ها یا مخزن هایی که شما مالک آن هستید استفاده می شود. تمامی این موارد با کمک src/calculateRank.js محاسبه می شود._

پنهان کردن آمارهای فردی

برای در نظر گرفتن بعضی از موارد می توانید از پارامتر ?hide= استفاده کنید و مقدارهای مورد نظرتان را اگر چند مورد هستند با کاراکتر کاما از هم جدا کنید.

گزینه: &hide=stars,commits,prs,issues,contribs

فعالیت های private خود را نیز به آمار کلی اضافه کنید.

شما می توانید با پارامتر ?count_private=true تمام فعالیت های priavate خود را نیز شامل این آمار کنید.

اگر خودتان از این ابزار استفاده کنید فعالیت های priavate شما هم محاسبه می شود و نیاز به تنظیم کردن آن ندارید ولی اگر از حالت فعلی و اشتراکی آن استفاده می کنید برای اینکه فعالیت های خصوصی یا priavate شما شامل آمار شود حتما این گزینه را فعال کنید.

گزینه: &count_private=true

نمایش آیکن ها

برای فعال کردن نمایش آیکون ها در کارت ها پارامتر show_icons=true را اضافه کنید:

قالب ها

با قالب های موجود می توانید سفارشی سازی های مورد نظر خود را انجام دهید و یا به صورت دستی شخصی سازی کنید.

از پارامتر &theme=THEME_NAME استفاده کنید :-

قالب های داخلی ابزار

• dark
• radical
• merko
• gruvbox
• tokyonight
• onedark
• cobalt
• synthwave
• highcontrast
• dracula

شما می توانید پیش نمایش قالب ها را در بخش همه قالب ها ببینید و تنظیمات آن ها را در فایل تنظیمات قالب بررسی کنید و اگر دوست دارید قالب جدیدی را به صورت مشارکتی به مخزن اضافه کنید 😀

سفارشی سازی

شما می توانید نمایش کارت های وضعیت و کارت های مخزن ها را با پارامترهای مورد نظرتان شخصی سازی کنید.

گزینه های متداول

• title_color – نام رنگ عنوان (کد رنگ هگزادسیمال)
• text_color – رنگ متن (کد رنگ هگزادسیمال)
• icon_color – رنگ آیکن ها در صورت در دسترس بودن (کد رنگ هگزادسیمال)
• border_color – رنگ کادر دور کارت (کد رنگ هگزادسیمال). (اگر hide_border فعال باشد این پارامتر تاثیری روی کارت ندارد)
• bg_color – رنگ پس زمینه ی کارت ها (کد رنگ هگزادسیمال) و اگر گرادیانت می خواهید از فرمت روبرو استفاده کنید: angle,start,end
• hide_border – پنهان کردن کادر دور کارت (بولین)
• theme – نام یک قالب را انتخاب کنیدهمه قالب ها
• cache_seconds – تنظیم دستی زمان کش برای محتوای کارت ها (کمترین: 1800, بیشترین: 86400) این پارامتر به ثانیه می باشد
• locale – زبان کارت ها (برای مثال. cn, de, es, etc.)
• border_radius – گرد بودن اطراف کارت ها

پس زمینه با گرادیانت

برای نمایش پس زمینه گرادیانت می توانید از چندین رنگ برای پس زمینه استفاده کنید و آن ها را با کاراکتر کاما جدا کنید:

نکته ای در مورد کش : کش شدن در این ابزار معمولا برای افرادی که کمتر از هزار ستاره و fork دارند هر 4 ساعت یکبار اتفاق می افتد و برای افرادی که بالاتر از این هستند هر 1 ساعت یکبار اتفاق می افتد البته این زمان ممکن است به 2 تا 24 ساعت تبدیل شود.

گزینه های اختصاصی برای کارت های آمار

• hide – پنهان کردن زبان های خاص از کارت (با کاما مقدارها را جدا کنید)
• hide_title – (بولین)
• hide_rank – (بولین) رتبه ها را مخفی کنید و اندازه ی کارت را به صورت خودکار در بیاورید.
• show_icons – (بولین)
• include_all_commits – کل کامیت ها را شامل شود به طور پیشفرض فقط یکسال را شامل می شود (بولین)
• count_private – شمارش کامیت های پرایویت یا private (بولین)
• line_height – تنظیم مقدار فاصله بین خطوط داخل کارت (عددی)
• custom_title – تنظیم کردن عنوان دلخواه برای کارت
• disable_animations – غیرفعال کردن تمام انیمیشن های داخل کارت (بولین)

گزینه های اختصاصی کارت repository

• show_owner – نمایش مالک مخزن (بولین)

گزینه های اختصاصی مربوط به کارت زبان ها

• hide – پنهان کردن زبان های خاص از کارت (با کاما مقدارها را جدا کنید)
• hide_title – (بولین)
• layout – بین دو طرح بندی پیشفرض و جمع و جور که مقدارهای default و compact را دارد سوییچ کنید.
• card_width – به صورت پیشفرض اندازه ی عرض کارت را انتخاب کنید (عددی)
• langs_count – تعداد زبان ها را با یک عدد صحیح بین 1 تا 10 انتخاب کنید و به صورت پیشفرض مقدار آن 5 می باشد (عددی)
• exclude_repo – مخازن مشخصی را حذف کنید (با کاما مقدارها را جدا کنید)
• custom_title – تنظیم کردن عنوان دلخواه برای کارت

⚠️ مهم: نام زبان ها باید به صورت uri-escaped باشد برای بررسی همه ی آنها Percent Encoding را ببینید (برای مثال: c++ باید تبدیل شود به c%2B%2B, برای jupyter notebook باید تبدیل شود به jupyter%20notebook, و …) می توانید استفاده کنید urlencoder.org را مشاهده کنید تا به شما کمک کند این کار را به صورت خودکار انجام دهید.

گزینه های اختصاصی کارت Wakatime

• hide – پنهان کردن زبان های خاص از کارت (با کاما مقدارها را جدا کنید)
• hide_title – (بولین)
• line_height – فاصله ی بین خطوط را در کدها مشخص کنید (عددی)
• hide_progress – پنهان کردن درصدها و نوارهای پیشرفت (بولین)
• custom_title – تنظیم کردن عنوان دلخواه برای کارت
• layout – بین دو طرح بندی پیشفرض و جمع و جور که مقدارهای default و compact را دارد سوییچ کنید.
• langs_count – محدودیت برای تعداد زبان ها اگر انتخاب نکنید نامحدود می شود
• api_domain – تنظیم کردن API domain دلخواه و اختصاصی شما برای مثال : Hakatime و Wakapi
• range – درخواست بازه دلخواه برای WakaTime, برای مثال last_7_days. می توانید WakaTime API docs را ببنید و در لیست آن گزینه های مختلف را بررسی کنید.

پین های اضافه گیت هاب

بخش پین ها در گیت هاب تنها 6 مورد را می تواند در پروفایل گیت هاب شما نمایش دهد و با امکانات این بخش می توانید تعداد بیشتری را نمایش دهید.

روش استفاده

به سادگی کدها را کپی پیست کنید و از آن ها استفاده کنید.

Endpoint: api/pin?username=anuraghazra&repo=github-readme-stats

پیش نمایش

از پارامتر یا متغیر show_owner استفاده کنید تا مالک مخزن یا repository را نمایش دهد.

کارت زبان های پراستفاده

کارت زبان های پر استفاده می تواند پر استفاده ترین زبان های برنامه نویسی که شما استفاده کرده اید را نمایش می دهد.

نکته : زبان های پر استفاده نمی تواند تخصص یا مهارت شما را در زبان خاصی نشان دهد و فقط مجموع مخزن های شما را بررسی می کند و به سادگی می تواند کدهایی که شما موجود دارید را شمارش کند.

روش استفاده

کدها را کپی پیست کنید و از آنها استفاده کنید.

Endpoint: api/top-langs?username=anuraghazra

مخازن خاص را در آمار نمایش داده شده حذف کنید

شما می توانید از پارامتر ?exclude_repo=repo1,repo2 استفاده کنید تا مخزن ها یا repositoryهای خاص را از آمار حذف کنید.

پنهان کردن برخی از زبان ها

برای استفاده از این امکان از پارامتر ?hide=language1,language2 استفاده کنید تا زبان های مورد نظرتون رو پنهان کنید.

نمایش زبان های بیشتر

شما می توانید از پارامتر &langs_count= استفاده کنید تا تعداد زبان ها را کم یا زیاد کنید. مقدار صحیح یک عدد مثبت بین 1 تا 10 می باشد و به صورت پیش فرض روی 5 تنظیم شده

طرح جمع و جور کارت زبان ها

شما می توانید از پارامتر &layout=compact استفاده کنید تا طراحی کارت را تغییر دهید

پیش نمایش

• طرح جمع و جور

آمار هفتگی Wakatime

فقط کافیست نام کاربری خودتون رو در ?username= به نام کاربری خودتون در Wakatime تغییر بدین

پیش نمایش

• طرح جمع و جور

همه ی دموها یا پیش نمایش ها

• پیش فرض

• پنهان کردن آمارهای خاص

• نمایش آیکن ها

• سفارشی سازی رنگ کادر

• شامل شدن همه ی کامیت ها

• قالب ها

از قالب های پیش فرض استفاده کنید

• گرادیانت

• سفارشی سازی کارت آمار

• تنظیم زبان کارت ها

• سفارشی سازی کارت مخزن ها

• پراستفاده ترین زبان ها

• کارت Wakatime

نکته سریع (تراز کردن کارت های Repo)

معمولاً نمی توانید تصاویر را در کنار هم قرار دهید. برای این کار می توانید از این روش استفاده کنید:

خودتون Deploy کنید

آموزش مرحله به مرحله ی انجام کار را با @codeSTACKr ببینید

چون Github API فقط می توان 5 هزار درخواست را مدیریت کند و برای راحت تر شدن و به مشکل نخوردن بهتر است این را برای خودتان روی سرور مورد نظرتان دپلوی کنید.

نکته: از #58 امکان مدیریت 5 هزار درخواست به وجود آمده است پس هیچ مشکل خرابی ای به وجود نمی آید. 😀