استيراد الوثائق الثابتة

يدعم موقع الويب هذا كلاً من Markdown الأصلي والوثائق الثابتة المعدة مسبقًا. تشرح هذه الصفحة آلية النشر؛ وهذا لا يعني أن أي مشروع هندسي لديه دليل بالفعل.

تخفيض السعر الأصلي

أنشئ docs/my-project/index.md واكتب Markdown بعنوان في المقدمة. أضف صفحات مثل docs/my-project/setup/index.md. الارتباط من الفهرس بـ [Setup](setup/)، والعودة بـ [Overview](../).

أضف المشروع إلى فهرس الوثائق . يمكن أن يكون لكل مشروع التنقل الصغير الخاص به أو الروابط في Markdown.

HTML مستورد

أنشئ وثائقك العامة محليًا باستخدام Documenter.jl أو MkDocs أو أي مولد ثابت آخر. قم بتكوين عنوان URL العام الخاص به إلى https://ahmelkholy.github.io/docs/my-project/ وتحقق من أن أصوله تستخدم روابط نسبية أو تلك البادئة المحددة.

انسخ المخرجات العامة التي تم إنشاؤها فقط إلى static-docs/my-project/. ارتكبها بجانب الموقع. يقوم خطاف ما بعد الكتابة في Jekyll بنسخ هذا الدليل بايت مقابل بايت إلى _site/docs/my-project/ بعد انتهاء Jekyll. لا يتم تفسير المادة السائلة والأمامية في الملفات المستوردة. يتم الاحتفاظ بالأصول ذات البادئة السفلية.

لا تقم أيضًا بإنشاء دليل docs/my-project/ الأصلي: يرفض البناء التصادمات. يتم رفض الارتباطات الرمزية والملفات المخفية. استخدم اسم مشروع آخر لإبقاء النموذجين منفصلين.

لا يقوم سير عمل النشر مطلقًا بإحضار مستودع آخر. يجب عدم تضمين المصادر الخاصة والدفاتر التي تحتوي على بيانات خاصة وبيانات الاعتماد والأدلة المحلية في المخرجات التي تم إنشاؤها.

المعاينة والتحقق

قم بتشغيل bundle exec jekyll build، ثم python3 scripts/check_site.py. للحصول على معاينة مباشرة، قم بتشغيل bundle exec jekyll serve؛ أعد تشغيله بعد استبدال الحزمة المستوردة لأن دليل الإدخال هذا مستبعد من مراقب ملفات Jekyll.

افتح المثال الثابت العامل أو ارجع إلى التأليف.