contributing-doc-site.md

بهبود ها

اینجا لیستی از بهبودهایی است که ما در مستندات به دنبال آن هستیم. اگر می خواهید مشارکت کنید، می توانید از لیست زیر انتخاب کنید:

• شخصی سازی قالب docsify
• تصویر زمینه cover-page
• گیف cover-page/readme از یک ترمینال که در حال استفاده و نمایش دادن قابلیت های زبان برنامه نویسی وان هست (تغییر نسخه اتوماتیک، .tool-versions با چندین کانفیگ زمان اجرا)
• دامنه سایت مستندات سفارشی
• تغییر تایپوگرافی
• ساخت یک لوگو؟
• بهبود دکمه/لینک "ویرایش در گیت هاب"
• اضافه کردن زبان برنامه نویسی وان به ویترین awesome-docsify

ایجاد محیط

ابزار های مورد استفاده ما:

• Node.js v10.15.0 برای پشتیبانی از بقیه ابزارهای مورد نیاز
• docsify برای ساخت سایت مستندات
• prettier برای قالب بندی فایل های علامت گذاری

نصب وابستگی ها

ما با استفاده از ابزار این سایت مستندات در تلاش هستیم تا از آلوده کردن مخزن اصلی بپرهیزیم. بنابراین بسیار خوب خواهد بود اگر بتوانید این ابزارهای توسعه را بصورت global نصب کنید تا نیاز نباشد که ما آنها را به این پروژه اضاف کنیم.

npm i docsify-cli prettier -g

اجرای سایت

در مسیر root پروژه دستور زیر را اجرا کنید:

docsify serve docs

قالب بندی قبل از commit

در مسیر root پروژه دستور زیر را اجرا کنید:

prettier --write "docs/**/*.md"

ترجمه ها

ارائه ترجمه برای زبانهای دیگر بسیار خوب خواهد بود.

Docsify اضافه کردن زبان جدید را ساده کرده است. در مسیر docs/index.html به مثال های zh-cn نگاه کنید.

افزودن ترجمه جدید

1. برای ترجمه جدید در مسیر docs/ یک فولدر بسازید.

   docs/
   docs/zh-cn/
   

2. در مسیر docs/_404.md فایل را به فولدر جدید docs/zh-cn/_404.md کپی کنید.

   docs/_404.md
   docs/zh-cn/_404.md
   

3. متن را با متن ترجمه شده جایگزین کنید.

4. این کار را برای همه فایل ها انجام بدهید.

5. برای ترجمه جدید در _navbar.md یک لینک اضافه کنید.

6. قبل از commit کردن prettier را اجرا کنید.

برای اطلاعات بیشتر، مستندات پیکربندی docsify، مستندات Custom navbar docsify، و سپس نگاهی به index.html search section بیندازید.