الإعداد الأولي للقالب

1. للبدء، ثبّت أولًا كل الحزم اللازمة عبر npm install أو pnpm install، ثم شغّل بناءً أوليًا للتأكد من أن الإعداد يعمل عبر npm run build أو pnpm build.
2. انسخ بناء Pagefind (الخاص ببحث الموقع) ليكون متاحًا لبيئة التطوير. يختلف هذا بحسب نظام التشغيل لديك. أنشأت بعض الأوامر للمساعدة.
   • على Windows، شغّل npm run winsearch
   • على OSX أو Linux، شغّل npm run osxsearch
3. بعد ذلك، ستحتاج إلى ضبط إعداد i18n الخاص بموقعك (لغة واحدة أو عدة لغات). شغّل الأمر npm run docs:config-i18n واتبع تعليمات السكربت لإتمام الإعداد!
4. الآن يمكنك تهيئة الموقع كما تحب!

جولات تعريفية بالكود

أنشأت بعض الجولات في الكود لتعريفك ببنية المشروع. ستحتاج إلى إضافة Code Tour لعرضها في VSCode أو في أي بيئة تطوير أخرى.

بنية الكود

الكود منظّم بحيث توجد معظم العناصر ضمن مجلد src/docs. هذا يسهّل نقل المجلد بالكامل إلى مشروع قائم وإضافة وظائف التوثيق خلال دقائق.

خيارات الإعداد

يجري الإعداد العام للموقع في مجلد src/docs/config/. معظم الإعدادات موجودة داخل مجلدات لغات منفصلة لتسهيل التعامل مع الترجمات.

إعدادات الموقع

يُستخدم ملف src/docs/config/siteSettings.json.ts لضبط إعدادات الموقع. تشمل أمورًا مثل تفعيل انتقالات العرض، وتفعيل الحركات، وإظهار أزرار نسخ الروابط لعناوين التوثيق.

بيانات الموقع

يُستخدم ملف src/docs/config/[language]/siteData.json.ts لضبط بيانات الموقع. يشمل ذلك أمورًا مثل عنوان الموقع ووصفه وروابط التواصل الاجتماعي والصورة الافتراضية.

بيانات التنقل

اضبط بيانات التنقل لشريط التنقل العلوي في ملف src/docs/config/[language]/navData.json.ts.

تخطيط الشريط الجانبي

اضبط ترتيب أقسام التوثيق في ملف src/docs/config/[language]/sidebarNavData.json.ts.

Robots

كي ترى برامج الزحف مثل Google خريطة الموقع الصحيحة، ستحتاج إلى تعديل ملف public/robots.txt ليستخدم نطاق موقعك.

مصادر إضافية

معلومات عامة عن Astro

يبحث Astro عن ملفات .astro أو .md في مجلد src/pages/. تُعرض كل صفحة كمسار بناءً على اسم ملفها.

لا يوجد شيء خاص في src/components/، لكنه المكان الذي نفضّل وضع أي مكوّنات Astro/React/Vue/Svelte/Preact فيه.

يمكن وضع أي أصول ثابتة، مثل الصور، في مجلد public/. كما أستخدم src/assets كثيرًا للصور عند الاعتماد على أصول Astro لتحسين الصور.

الأوامر

تُشغَّل جميع الأوامر من جذر المشروع، من الطرفية:

الأمر	الإجراء
npm install	يثبّت الاعتماديات
npm run dev	يشغّل خادم التطوير المحلي على localhost:4321
npm run build	يبني موقع الإنتاج في ./dist/
npm run preview	يعاين البناء محليًا قبل النشر
npm run astro ...	يشغّل أوامر CLI مثل astro add و astro check
npm run astro -- --help	يعرض المساعدة الخاصة بـ Astro CLI

تريد معرفة المزيد؟

اطّلع على التوثيق أو انضم إلى خادم Discord.