كيفية تضمين مخططات حورية البحر في مشروع جيثب الخاص بك

أعلنت منصة مشاركة التعليمات البرمجية الشهيرة ، GitHub ، عن دعمها لنوع جديد من المحتوى المضمن. في ملفات markdown ، يمكنك الآن استخدام بناء جملة Mermaid لإنشاء مخططات انسيابية ومخططات تسلسل وغير ذلك بسهولة.

تتعامل ميزة تخفيض السعر في GitHub بالفعل مع الصور وقوائم المهام والرموز القصيرة للرموز التعبيرية. مع دعم المخططات الشائعة ، يقوم GitHub بعمله من أجل توثيق أكثر إفادة ومفيدة.

ما الجديد مع GitHub؟

يمكنك الآن تضمين رمز حورية البحر في ملف README.md وملفات تخفيض السعر الأخرى. إذا قمت بذلك ، فسيقوم GitHub بعرض مخطط موصوف بواسطة هذا الرمز. يستخدم رمز حورية البحر تركيبًا بسيطًا يصف الأجزاء الفردية لكل مخطط بنص عادي.

أنظر أيضا: ما هو جيثب؟ مقدمة لمميزاته الأساسية

كيف تقوم بتضمين المخططات؟

1. اختر إما ملف تخفيض السعر الحالي أو أنشئ ملفًا جديدًا لإضافته إلى مستودعك. استخدام إما .md أو .تخفيض السعر ملحقات.
2. أضف بعض كود حورية البحر إلى هذا الملف. بالضبط ما هو رمز متروك لك ؛ إليك مثال بسيط للبدء:

   TD الرسم البياني ؛
    أ -> ب ؛
    أ -> ج ؛
    ب -> د ؛
    ج -> د ؛

3. اعرض الملف على GitHub. يجب أن ترى عرضًا رائعًا للرسم التخطيطي الخاص بك.

الآن تحتاج فقط إلى معرفة ثروة المخططات المتوفرة لدى حورية البحر. أو يمكنك ببساطة الرجوع إلى حورية البحر التوثيق عندما تحتاج إلى رسم تخطيطي.

ما أنواع المخططات التي يمكنني استخدامها؟

يدعم حورية البحر الأنواع التالية من الرسوم البيانية:

• مخطط
• تسلسل
• فصل
• حالة
• علاقة الكيان
• رحلة المستخدم
• جانت
• فطيرة
• المتطلبات

أنظر أيضا: مخطط جانت مقابل. مخطط بيرت: ما هي الاختلافات؟

لكل منها بناء الجملة الخاص به ، لعكس نوع البيانات التي يعرضها الرسم التخطيطي. على سبيل المثال ، إليك رمز مخطط تسلسل بسيط:

مخطط تسلسل
 بارت - >> هومر: ليس لديك بقرة يا رجل.

الذي يبدو مثل هذا عند تقديمه:

وإليك رمز مخطط الحالة الأساسي:

الحالة
 [*] -> جديد
 جديد -> جاهز: اعترف
 جاهز -> قيد التشغيل: إرسال المجدول
 قيد التشغيل -> جاهز: المقاطعة
 قيد التشغيل -> انتظار: I / O أو حدث انتظار
 قيد الانتظار -> جاهز: I / O أو اكتمال الحدث
 قيد التشغيل -> تم الإنهاء: خروج
 تم الإنهاء -> [*]

مما يجعله على هذا النحو:

أضف قيمة إلى مشاريع GitHub الخاصة بك باستخدام مخططات حورية البحر

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

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

كيفية استضافة موقع مجانًا باستخدام صفحات جيثب

إذا كان لديك موقع ويب بسيط ، فلن تحتاج إلى الدفع مقابل استضافة الويب. يمكنك استخدام صفحات GitHub مجانًا!

اقرأ التالي

عن المؤلف