1. الرئيسية
  2. مسارات التعلم
  3. تعلم Markdown لكتابة التوثيق وملفات README
  4. كتابة ملف README احترافي ووثائق المشاريع باستخدام Markdown
تعلم Markdown لكتابة التوثيق وملفات READMEالدرس 3 من 3

كتابة ملف README احترافي ووثائق المشاريع باستخدام Markdown

آخر درس في دورة Markdown: هيكل ملف README احترافي على GitHub، ونصائح التوثيق، والعربية واتجاه النص RTL، وتصدير الملف إلى HTML.

محتويات الدرس
  1. هيكل مقترح
  2. نصائح تجعله احترافيًا
  3. العربية واتجاه النص
  4. من Markdown إلى صفحة
  5. التمرين الختامي

ملف README.md هو أول ما يراه الزائر في مستودعك. ملف جيد يجعل الناس يفهمون مشروعك ويثقون به في دقيقة.

هيكل مقترح

markdown
# اسم المشروع

وصف في سطر أو سطرين: ماذا يفعل ولمن.

![لقطة شاشة](docs/screenshot.png)

## المميزات
- ميزة أولى
- ميزة ثانية

## التثبيت
```bash
git clone https://github.com/user/project.git
cd project
npm install
npm start
```

## الاستخدام
مثال قصير يوضح أهم شيء.

## المساهمة
افتح Issue قبل أي تغيير كبير.

## الرخصة
MIT

نصائح تجعله احترافيًا

  • ابدأ بالقيمة: ما المشكلة التي يحلها؟ لا تبدأ بتاريخ المشروع.
  • أوامر قابلة للنسخ: ضع كل أمر في كتلة كود بلغة bash.
  • صورة أو GIF: تختصر فقرات من الشرح.
  • جدول المحتويات: للملفات الطويلة، روابط إلى العناوين مثل [التثبيت](#التثبيت).

العربية واتجاه النص

Markdown لا تحدد الاتجاه. على GitHub يمكنك تغليف الأجزاء العربية بوسم HTML:

markdown
<div dir="rtl">

## مقدمة
هذا النص يظهر من اليمين إلى اليسار.

</div>

اترك سطرًا فارغًا بعد الوسم وقبل إغلاقه حتى تعمل Markdown داخله.

من Markdown إلى صفحة

في محرر Markdown اضغط تصدير HTML لتحصل على صفحة كاملة بتنسيق يشبه GitHub، جاهزة للرفع أو المشاركة. ولتتعلم بناء صفحاتك بنفسك راجع دورة HTML.

التمرين الختامي

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