ما هي Markdown؟
Markdown هي لغة ترميز تقدم نهجا بسيطا لتحرير المحتوى من خلال حماية منشئي المحتوى من حمل HTML. في حين أن HTML رائع لعرض المحتوى بالطريقة التي تم تصميمه لأجلها بالضبط، إلا أنه يشغل مساحة كبيرة ويمكن أن يكون من الصعب العمل معه، حتى في الجرعات الصغيرة. يقدم Markdown حلا وسطا فعالا بين قوة HTML لوصف المحتوى وسهولة النص العادي للتحرير.
في هذه الوحدة، سنناقش بنية Markdown وبناء الجملة. سنغطي أيضا ميزات GitHub-Flavored Markdown (GFM) ، بما في ذلك ملحقات دمج ميزات GitHub في المحتوى الخاص بك.
إشعار
تهدف هذه الوحدة إلى إعطائك فكرة عما يدور حول Markdown. للحصول على مراجعة أكثر تعمقا، راجع وصف بناء جملة Markdown ومقالات GitHub-Flavored Markdown Spec في وحدة الملخص الخاصة بهذه الوحدة النمطية.
إبراز النص
عادة ما يكون الجزء الأكثر أهمية من أي اتصال على GitHub هو النص نفسه، ولكن كيف يمكنك إظهار أن بعض أجزاء النص أكثر أهمية من غيرها؟
إن استخدام الخط المائل في النص يعد أمراً سهلاً كما هو الحال مع إحاطة النص الهدف بالعلامة النجمية (*) أو علامات التسطير السفلي الفردية (_). فقط تأكد من إغلاق التركيز بنفس الحرف الذي استخدمته لفتحه. انتبه إلى الاتساق عند الجمع بين العلامات النجمية والشرطات السفلية. فيما يلي عدة أمثلة:
This is *italic* text.
This is also _italic_ text.
هذا نص مائل لنص. هذا هو أيضاً نص مائل.
قم بإنشاء نص غامق باستخدام اثنين من علامات النجمة (**) أو اثنين من علامات التسطير السفلي (__).
This is **bold** text.
This is also __bold__ text.
هذا نصغامق. هذا هو أيضاً نص غامق.
يمكنك أيضًا مزج تأكيدات مختلفة.
_This is **italic and bold** text_ using a single underscore for italic and double asterisks for bold.
__This is bold and *italic* text__ using double underscores for bold and single asterisks for italic.
هذا نص مائل وغامق باستخدام علامة تسطير سفلي فردية للنص المائل وعلامات نجمية مزدوجة للنص الغامق. هذا نص غامق ومائل باستخدام علامات تسطير سفلي مزدوجة للنص الغامق وعلامات نجمية فردية للنص المائل.
لاستخدام علامة نجمية حرفية، قبلها بحرف إلغاء؛ في GFM، هذه ردة فعل عكسية (\). يعرض هذا الشرطات السفلية والعلامات النجمية كنص عادي.
\_This is all \*\*plain\*\* text\_.
_هذا النص كله نص **plain**_.
الإعلان عن العناوين
يوفر HTML عناوين المحتوى مثل العلامة <h1> . في Markdown، يتم دعم هذا عبر الرمز #. ما عليك سوى استخدام رقم واحد لكل مستوى عنوان من 1 إلى 6.
###### This is H6 text
هذا هو النص H6
الارتباط بالصور والمواقع
تتبع روابط الصور والمواقع بنية مماثلة.

[Link to Microsoft Training](/training)
إنشاء قوائم
يمكنك تحديد القوائم المرتبة أو غير المرتبة. يمكنك أيضا إنشاء عناصر متداخلة من خلال المسافة البادئة.
- تبدأ القوائم المرتبة بالأرقام.
- يمكن للقوائم غير المرتبة استخدام العلامات النجمية أو الشرطات (
-).
فيما يلي Markdown لقائمة مرتبة:
1. First
1. Second
1. Third
النتيجة:
- First
- ثانية
- الثالث
إليك Markdown لقائمة غير مرتبة:
- First
- Nested
- Second
- Third
- أولا
- متداخل
- ثانية
- الثالث
إنشاء الجداول
يمكنك إنشاء جداول باستخدام مجموعة من الخطوط المستقيمة الرأسية (|) لفواصل الأعمدة والشرطات (-) لتعيين الصف السابق كرأس.
First|Second
-|-
1|2
3|4
First ثانية 1 2 3 4
نص عرض الأسعار
يمكنك إنشاء علامات الاقتباس باستخدام الحرف الأكبر من (>).
> This is quoted text.
هذا نص مقتبس.
سد الفجوات باستخدام HTML المضمن
إذا صادفت سيناريو HTML غير معتمد من قبل Markdown، يمكنك استخدام HTML المضمن.
Here is a<br />line break
هنا
فاصل الأسطر
العمل مع التعليمات البرمجية
يوفر Markdown السلوك الافتراضي للعمل مع كتل التعليمة البرمجية المضمنة المحددة بواسطة حرف علامة الاقتباس المسماة backtick (`). يؤدي التفاف النص في علامات خلفية إلى جعله رمزا.
This is `code`.
هذا هو
code.
إذا كان لديك مقطع تعليمة برمجية يمتد على عدة أسطر، فيمكنك استخدام ثلاث علامات (```) قبل وبعد لإنشاء كتلة تعليمات برمجية محاطة بما يشبه السياج.
```markdown
var first = 1;
var second = 2;
var sum = first + second;
```
var first = 1; var second = 2; var sum = first + second;
يوسع GFM هذا الدعم مع تسليط الضوء على بناء الجملة للغات الشائعة. ما عليك سوى تحديد اللغة كجزء من تسلسل التجزئة الأول.
```javascript
var first = 1;
var second = 2;
var sum = first + second;
```
var first = 1; var second = 2; var sum = first + second;
المشكلات عبر الارتباطات وطلبات السحب
يدعم GFM تنسيقات الرموز القصيرة المختلفة لتسهيل الربط بالمشكلات وطلبات السحب. أسهل طريقة للقيام بذلك هي استخدام تنسيق #ID، مثل #3602. يقوم GitHub تلقائيا بضبط الارتباطات الأطول لهذا التنسيق إذا قمت بلصقها. توجد أيضاً اصطلاحات إضافية يمكنك اتباعها، على سبيل المثال إذا كنت تعمل باستخدام أدوات أخرى أو تريد تحديد مشاريع/فروع أخرى.
| نوع المرجع | مرجع خام | ارتباط قصير |
|---|---|---|
| إصدار أو سحب طلب عنوان URL | https://github.com/desktop/desktop/pull/3602 |
#3602 |
# وإصدار أو سحب عدد الطلب |
#3602 | #3602 |
GH- وإصدار أو سحب عدد الطلب |
GH-3602 | GH-3602 |
Username/Repository# وإصدار أو سحب عدد الطلب |
desktop/desktop#3602 | desktop/desktop#3602 |
لمزيد من المعلومات، راجع مقالة المراجع وعناوين URL المرتبطة تلقائيا في وحدة الملخص الخاصة بهذه الوحدة النمطية.
ربط تثبيتات محددة
يمكنك الارتباط بالتثبيت إما عن طريق اللصق في معرفه أو ببساطة باستخدام خوارزمية التجزئة الآمنة (SHA).
| نوع المرجع | مرجع خام | ارتباط قصير |
|---|---|---|
| تثبيت عنوان URL | https://github.com/desktop/desktop/commit/ | |
| 8304e9c271a5e5ab4fda797304cd7bcca7158c87 | 8304e9c | |
| SHA | 8304e9c271a5e5ab4fda797304cd7bcca7158c87 | 8304e9c |
| User@SHA | desktop@8304e9c271a5e5ab4fda797304cd7bcca7158c87 | desktop@8304e9c |
| Username/Repository@SHA | desktop/desktop@8304e9c271a5e5ab4fda797304cd7bcca7158c87 | desktop/desktop@8304e9c |
الإشارة إلى المستخدمين والفرق
@ كتابة رمز متبوعا باسم مستخدم GitHub يرسل إشعارا إلى هذا الشخص حول التعليق. وهذا ما يسمى "@mention" ، ويسلط الضوء على المستخدم أو الفريق.
@githubteacher
تعقب قوائم المهام
يمكنك إنشاء قوائم مهام ضمن المشكلات أو سحب الطلبات باستخدام بناء الجملة التالي. يمكن أن تكون هذه مفيدة لتتبع التقدم عند استخدامها في النص الأساسي لمشكلة أو طلب السحب.
- [x] First task
- [x] Second task
- [ ] Third task
أوامر الشرطة المائلة
يمكن أن توفر لك أوامر الشرطة المائلة الوقت عن طريق تقليل الكتابة المطلوبة لإنشاء محتوى منظم.
يمكنك استخدام أوامر الشرطة المائلة في أي حقل وصف أو تعليق في المشكلات أو طلبات السحب أو المناقشات حيثما كانت مدعومة.
| الأمر | الوصف |
|---|---|
/code |
إدراج كتلة تعليمة Markdown البرمجية. يمكنك اختيار اللغة. |
/details |
إدراج منطقة تفاصيل قابلة للطي. يمكنك اختيار العنوان والمحتوى. |
/saved-replies |
إدراج رد محفوظ. يمكنك الاختيار من بين الردود المحفوظة لحساب المستخدم الخاص بك. إذا أضفت %cursor% إلى الرد المحفوظ، فإن الأمر المائل يضع المؤشر في هذا الموقع. |
/table |
إدراج جدول Markdown. يمكنك اختيار عدد الأعمدة والصفوف. |
/tasklist |
إدراج قائمة مهام. يعمل هذا الأمر المائل فقط في وصف المشكلة. |
/template |
يعرض جميع القوالب في المستودع. يمكنك اختيار القالب الذي تريد إدراجه. يعمل هذا الأمر المائل لقوالب المشكلة وقالب طلب سحب. |