مستندات با VitePress ساخته شده است و وابستگی به @vue/theme دارد. محتوای وب‌سایت با فرمت Markdown در مسیر src نوشته شده است. برای ویرایش‌های ساده، می‌توانید مستقیماً فایل را در GitHub ویرایش کرده و Pull Request ایجاد کنید.

برای توسعه، pnpm به عنوان Package Manager توصیه می‌شود:

pnpm i
pnpm run dev

این پروژه نیاز به Node.js نسخه v14.0.0 یا بالاتر دارد، زیرا ما از ویژگی‌های جدید جاوااسکریپت مانند optional chaining در کدها استفاده می‌کنیم.

در مستندات VitePress، می‌توانید در مورد Markdown Extentions پشتیبانی‌شده و قابلیت استفاده از دستورات Vue داخل Markdown بیشتر بخوانید.

برای دستورات و توصیه‌های ما درباره نوشتن و حفظ محتوای مستندات، به راهنمای نوشتاری ما مراجعه کنید.

اول از همه ما از مشارکت شما خرسنیدم و به شدت از علاقه‌مندی شما به پیشرفت مستندات فارسی فریمورک Vue حمایت می‌کنیم. شما می‌توانید از طریق ترجمه صفحات و بهبود کیفیت صفحات ترجمه‌شده این پروژه را یاری کنید. برای اصلاحات جزئی می‌توانید مستقیما فایل را در گیت‌هاب ویرایش کرده و به آسانی Pull Request ایجاد کنید.

برای مشارکت در ترجمه صفحات مراحل زیر را طی کنید:

• مرحله اول: در ابتدا از این ریپازیتوری fork گرفته و آن را در سیستم خود pull کنید. سپس می‌توانید یک نگاه جزئی به پروژه برای آشنایی با ساختار آن داشته باشید. همچنین توجه کنید که برای ترجمه کردن مستندات شما نیازی به یادگیری فریمورک VitePress ندارید.
• مرحله دوم: برای افزایش کیفیت ترجمه مستندات حتما بخش واژه‌نامه و شیوه نگارش را مطالعه کنید.
• مرحله سوم: در سایت اصلی یک صفحه را برای ترجمه انتخاب کنید، سپس صفحه‌ای که برای ترجمه انتخاب کرده‌اید را در این لیست بررسی کنید تا مطمئن شوید ترجمه نشده و یا شخص دیگری درحال ترجمه آن نیست، سپس می‌توانید آن را به مشارکت‌کنندگان اعلام کرده و ترجمه صفحه را آغاز کنید.
• مرحله چهارم: بعد از اتمام کامل ترجمه صفحه، می‌توانید یک Pull Request ایجاد کنید تا بعد از بررسی تایید شود.

پی‌نوشت اول: هرگز مشکلات مربوط به RTL قالب سایت را اصلاح نکنید، آنها به زودی رفع خواهند شد.

پی‌نوشت دوم: خواندن شیوه نگارش مستندات اصلی Vue می‌تواند در فرایند ترجمه برای شما مفید باشد.

هم‌اکنون در مرحله ۴ (از ۵ مرحله) قرار داریم. هدف فعلی ما ترجمه کامل مستندات و انتشار آن روی دامنه اصلی می‌باشد. برای جزئیات بیشتر و اطلاع از فرایند کلی پروژه این صفحه را مطالعه کنید.

در گروه تلگرامی @Vue_Docs_Fa یا بخش issues می‌توانید با مشارکت‌کنندگان به طور مستقیم در ارتباط باشید.