يمكنك إضافة أنواع مختلفة من البيانات الوصفية إلى السمة. يتم تخزين بعضها في الملف about.json، ويتم تخزين البعض الآخر في ملفات اللغة المحلية.
about.json
معلومات تنسيق الملف
name (سلسلة نصية، مطلوب): الاسم الافتراضي للسمة عند تثبيتها. يمكن للمسؤولين تغييره بعد تثبيت السمة.
component (قيمة منطقية، القيمة الافتراضية false): ما إذا كان يجب التعامل مع السمة كمكون.
license_url (سلسلة نصية، اختياري): عنوان URL لملف الترخيص. سيتم عرض رابط لهذا في واجهة المسؤول. تستخدم معظم السمات هذا للربط بملف الترخيص الخاص بها على GitHub.
about_url (سلسلة نصية، اختياري): عنوان URL يحتوي على مزيد من المعلومات حول السمة. سيتم عرض رابط لهذا في واجهة المسؤول. تستخدم معظم السمات هذا للربط بموضوعها على Meta.
authors (سلسلة نصية، اختياري): سلسلة نصية لوصف مؤلف السمة. يتم عرضها في واجهة المسؤول.
theme_version (سلسلة نصية، اختياري): سلسلة نصية عشوائية لوصف إصدار السمة. يتم عرضها في واجهة المسؤول.
screenshots (مصفوفة، اختياري): ما يصل إلى مسارين لقطة شاشة سيتم استخدامهما في أماكن مختلفة من واجهة المستخدم لعرض لقطات شاشة للسمة. انظر أدناه لمزيد من التفاصيل حول القيود.
minimum_discourse_version (سلسلة نصية، اختياري): أبكر إصدار Discourse متوافق مع هذه السمة. إذا لم يتطابق، سيتم تعطيل السمة تلقائيًا. يجب أن يكون بالتنسيق 2.4.0.beta1.
maximum_discourse_version (سلسلة نصية، اختياري): أحدث إصدار Discourse متوافق مع هذه السمة. إذا لم يتطابق، سيتم تعطيل السمة تلقائيًا. يجب أن يكون بالتنسيق 2.4.0.beta1.
ملفات اللغة المحلية (مثل en.yml)
معلومات تنسيق الملف
theme_metadata.description: وصف مُوطَّن للسمة. يتم عرضه في واجهة المسؤول.
theme_metadata.settings.setting_name: وصف مُوطَّن لـ setting_name، يتم عرضه أسفل إعداد السمة في لوحة المسؤول.
لقطات الشاشة
يمكن للسمات والمكونات تحديد حد أقصى لقطتي شاشة في المفتاح screenshots في about.json، والذي سيبدو شيئًا كهذا:
"screenshots": ["screenshots/light.webp", "screenshots/dark.webp"]
ضع هذه القيود في الاعتبار:
- يجب أن تكون لقطات الشاشة في مجلد
screenshotsفي مستودع GitHub الخاص بالسمة - الحد الأقصى لحجم الملف:
1 MB - الحد الأقصى للدقة:
3840×2160(4K) - النسبة الموصى بها:
16:9 - التنسيقات المسموح بها:
.webp،.png،.jpeg،.jpg
نحن نتبع أيضًا اصطلاحًا لتضمين لقطات شاشة light و dark.
يتم التحكم في إصدار هذه الوثيقة - اقترح تغييرات على github.