Markdown Toolbox Logo Markdown Toolbox
الصفحة الرئيسية
مدونة

مستندات Bitbucket بصيغة Markdown

2024-02-14

نسخة قصيرة

في ملف README.md الخاص بك على Bitbucket، يمكنك استخدام Markdown لتنسيق نصك. إليك مثال:

# عنوان المشروع

وصف موجز لما يفعله هذا المشروع ومن هو موجه له.

## التثبيت

```bash
npm install my-project

الاستخدام

import my_project
my_project.start()

نسخة طويلة

المقدمة

Markdown هي لغة ترميز خفيفة توفر صيغة تنسيق نص عادي يمكن تحويلها إلى HTML. تُستخدم على نطاق واسع لملفات README في المستودعات على Bitbucket.


الصياغة الأساسية

تسمح لك Markdown بالكتابة باستخدام تنسيق نص عادي سهل القراءة والكتابة، والذي يتم تحويله بعد ذلك إلى HTML صالح بناءً. إليك دليل سريع للأساسيات:

  • العناوين استخدم # لعنوان، و## لعنوان من المستوى الثاني، وما إلى ذلك.
  • التوكيد استخدم *مائل* أو _مائل_ للمائل، و**عريض** أو __عريض__ للعريض.
  • القوائم تستخدم القوائم غير المرتبة نجوم، وزيادات، وشرطات (*، +، و-) بشكل متبادل كعلامات للقائمة. تستخدم القوائم المرتبة الأرقام.
  • الروابط [نص الرابط](http://url) لإنشاء رابط.

والمزيد. للحصول على صياغة مفصلة، قم بزيارة دليل Markdown.


الخلاصة

استخدام Markdown في ملفات README الخاصة بك على Bitbucket سيجعلها أكثر قراءة وإفادة. تذكر، يمكن أن تؤثر الوثائق الفعالة بشكل كبير على قابلية الاستخدام وتبني مشروعك.