just the docs

فقط المستندات

قالب Jekyll حديث وقابل للتخصيص بدرجة كبيرة وسريع الاستجابة للتوثيق مع بحث مدمج.
يمكن استضافتها بسهولة على صفحات GitHub مع القليل من التبعيات.

رؤيته في العمل!

مقطع فيديو تفصيلي لمختلف ميزات Just the Docs

just-the-docs-features-walkthrough.mp4

تثبيت

استخدم القالب

يوفر قالب Just the Docs الطريقة الأبسط والأسرع والأسهل لإنشاء موقع ويب جديد يستخدم سمة Just the Docs. للبدء في إنشاء موقع، ما عليك سوى النقر على "استخدام القالب"!

ملحوظة: لاستخدام السمة، لا تحتاج إلى استنساخ أو تفرع مستودع Just the Docs! يجب عليك القيام بذلك فقط إذا كنت تنوي تصفح مستندات السمات محليًا، أو المساهمة في تطوير السمة، أو تطوير سمة جديدة تعتمد على Just the Docs.

يمكنك بسهولة تعيين الموقع الذي تم إنشاؤه بواسطة القالب ليتم نشره على صفحات GitHub - يشرح ملف README للقالب كيفية القيام بذلك، إلى جانب تفاصيل أخرى.

إذا تم تثبيت Jekyll على جهاز الكمبيوتر الخاص بك، فيمكنك أيضًا إنشاء الموقع الذي تم إنشاؤه ومعاينته محليًا . يتيح لك هذا اختبار التغييرات قبل تنفيذها، وتجنب انتظار صفحات GitHub. ¹ وستكون قادرًا على نشر البنية المحلية الخاصة بك على نظام أساسي مختلف عن صفحات GitHub.

وبشكل أكثر تحديدًا، الموقع الذي تم إنشاؤه:

• يستخدم أسلوبًا يعتمد على الأحجار الكريمة، أي يستخدم Gemfile ويقوم بتحميل جوهرة just-the-docs
• يستخدم سير عمل GitHub Pages/Actions لإنشاء الموقع ونشره على صفحات GitHub

بخلاف ذلك، لديك الحرية في تخصيص المواقع التي تقوم بإنشائها باستخدام القالب، كيفما تشاء. يمكنك بسهولة تغيير إصدارات just-the-docs وJekyll التي يستخدمها، بالإضافة إلى إضافة المزيد من المكونات الإضافية.

استخدم روبي جيمز

وبدلاً من ذلك، يمكنك تثبيت السمة كجوهرة روبي، دون إنشاء موقع جديد.

أضف هذا السطر إلى Gemfile الخاص بموقع Jekyll:

 gem "just-the-docs"

وأضف هذا السطر إلى _config.yml الخاص بموقع Jekyll :

 theme : just-the-docs

ومن ثم تنفيذ:

 $ bundle

أو قم بتثبيته بنفسك على النحو التالي:

 $ gem install just-the-docs

وبدلاً من ذلك، يمكنك تشغيله داخل Docker أثناء تطوير موقعك

 $ docker-compose up

الاستخدام

عرض الوثائق للحصول على معلومات الاستخدام.

المساهمة

نرحب بتقارير الأخطاء ومقترحات الميزات الجديدة وطلبات السحب على GitHub على https://github.com/just-the-docs/just-the-docs. يهدف هذا المشروع إلى أن يكون مساحة آمنة ومرحبة للتعاون، ومن المتوقع أن يلتزم المساهمون بمدونة قواعد سلوك ميثاق المساهمين.

إرسال تغييرات التعليمات البرمجية:

• أرسل مشكلة تحفز التغييرات، باستخدام القالب المناسب
• ناقش التغييرات المقترحة مع المستخدمين الآخرين والمشرفين
• افتح طلب السحب
• تأكد من اجتياز جميع اختبارات CI
• تقديم تعليمات للتحقق من تأثير التغييرات
• في انتظار مراجعة الكود

مبادئ التصميم والتطوير لهذا الموضوع:

1. أقل عدد ممكن من التبعيات
2. لا حاجة لبرنامج نصي للبناء
3. تجربة الهاتف المحمول من الدرجة الأولى
4. جعل المحتوى يلمع

تطوير

لإعداد بيئتك لتطوير هذا الموضوع: قم بتفرع هذا الريبو، bundle install التشغيل من الدليل الجذر.

تم تضمين تكوين حاوية التطوير الحديث لـ VSCode.

تم إعداد المظهر الخاص بك تمامًا مثل موقع Jekyll العادي! لاختبار السمة الخاصة بك، قم بتشغيل bundle exec jekyll serve وافتح متصفحك على http://localhost:4000 . يؤدي هذا إلى بدء تشغيل خادم Jekyll باستخدام المظهر الخاص بك. أضف الصفحات والمستندات والبيانات وما إلى ذلك كالمعتاد لاختبار محتويات القالب الخاص بك. عندما تقوم بإجراء تعديلات على القالب الخاص بك والمحتوى الخاص بك، سيتم إعادة إنشاء موقعك ويجب أن ترى التغييرات في المتصفح بعد التحديث، تمامًا مثل المعتاد.

عندما يتم إصدار هذا المظهر، سيتم تضمين الملفات الموجودة في _layouts و _includes و _sass التي يتم تتبعها باستخدام Git فقط في الجوهرة.

رخصة

الموضوع متاح كمصدر مفتوح بموجب شروط ترخيص MIT.

الحواشي

1. قد يستغرق نشر التغييرات على موقعك ما يصل إلى 10 دقائق بعد دفع التغييرات إلى GitHub. ↩