روش استفاده از markdown‌

روش استفاده از markdown 

مفهوم Markdown یک نحوه‌ی سبک نوشتاری برای ایجاد مستندات است. این نوع نوشتار در گیت هاب بسیار کاربردی است. در این نوشته به بررسی نوع نوشتن یا syntax در Markdown می‌پردازیم. از Markdown می‌توانید در فایل readme.md استفاده کنید.

روش استفاده از markdown‌

markdown چیست؟

مارک داون یک نوع نوشتار برای اسناد است که به سادگی قابل نوشتن است. در این نوع نوشتار شما برای تعریف تصویر، لینک، لیست‌ها، پاراگراف‌ها، عنوان‌ها و … می‌توانید به سادگی کد بنویسید. البته نمی‌توان به آن مفهوم کدنویسی را داد زیرا اجرا نمی‌شود و تنها یک زبان نشانه گذاری است.

اما در گیت هاب markdown چه کاربردی دارد‌؟

• در بخش Gists گیت هاب.
• در بخش نظرات بخش‌های Issues و Pull Requests.
• در فایل‌هایی با پسوند md که مخفف markdown است. (مثل readme.md)

پیشنهاد نویسنده‌: اگر اکانت گیت‌هاب شما تحریم شده است تجربه‌ی من از بازکردن تحریم گیت هاب را بخوانید…

روش استفاده از markdown 

افزودن عنوان یا header در markdown 

اگر آموزش‌های html ما را دیدید در بخش تگ‌های عنوان داشتیم که تگ‌های عنوان بین h1 تا h6 هستند. در markdown هم این موضوع موجود است. با کمک کاراکتر هشتگ یا # می‌توانید این عنوان‌ها را ایجاد کنید.

# متن عنوان

## متن عنوان

### متن عنوان

#### متن عنوان

##### متن عنوان

######  متن عنوان

در markdonw شما امکان استفاده از زبان فارسی را نیز دارید.

افزودن متن کج یا italic در markdown 

برای اضافه کردن متن‌های کج یا italic در markdown می‌توانید از کاراکترها ستاره * یا زیرخط _ می‌توانید استفاده کنید؛ نکته این که باید در ابتدا و انتهای آن خط این کاراکتر را تکرار کنید که متن به صورت italic شود و با لیست‌های مرتب و نامرتب اشتباه نشود.

*italic text*
_italic text_

دقت کنید اولین و آخرین کاراکتری که در این خط قرار است به عنوان متن italic یا کج در نظر گرفته شود حتما باید به کاراکتر ستاره یا زیرخط بچسپد.

افزودن متن توپر یا bold در markdown 

برای اضافه کردن متن توپر یا bold به مثل متن‌های italic می‌توانید عمل کنید و از کاراکتر ستاره * و یا زیرخط _ استفاده کنید اما تفاوت در این بخش این است که باید این کاراکترهای دوبار در ابتدا و دوبار در انتها تکرار شود.

**bold text**
__bold text__

دقت کنید اولین و آخرین کاراکتری که در این خط قرار است به عنوان متن bold یا توپر در نظر گرفته شود حتما باید به کاراکتر ستاره یا زیرخط بچسپد.

افزودن لیست‌های مرتب یا ol در markdown 

برای افزودن لیست‌های مرتب که با شماره‌های مرتب شده است در ابتدا خط آن عدد را بنویسید و کاراکتر نقطه را بگذارید و یک فاصله هم بگذارید.

1. One
2. Two
3. Three
   1. Item Three-1
   1. Item Three-2
4. Four
5. Five

خروجی قابل مشاهده

1. One
2. Two
3. Three
   1. Item Three-1
   2. Item Three-2
4. Four
5. Five

همان‌طور که در نمونه‌ی بالا می‌بینید با کاراکترهای فاصله می‌توانید لیست‌های مرتب تودرتو هم ایجاد کنید.

افزودن لیست‌های نامرتب یا ul در markdown 

برای افزودن لیست‌های نامرتب که با بولت‌ها مشخص شده است در ابتدای خط از کاراکتر ستاره استفاده کنید و البته حتما بعد از کاراکتر ستاره یه فاصله گذاشته و بعد متن یا کلمه‌ی مورد نظر خود را بنویسید. در انتهای خط مثل متن‌های italic یا bold نیاز نیست چیزی بگذارید.

* Item 1
* Item 2
  * Item 2-1
  * Item 2-2
* Item 3
* Item 4

خروجی قابل مشاهده

• Item 1
• Item 2
  • Item 2-1
  • Item 2-2
• Item 3
• Item 4

همان‌طور که در نمونه‌ی بالا می‌بینید با کاراکترهای فاصله می‌توانید لیست‌های نامرتب تودرتو هم ایجاد کنید. به جز کاراکتر ستاره در ایجاد لیست‌های نامرتب می‌توانید از کاراکتر زیرخط یا underline نیز استفاده کنید.

افزودن تصویر در markdown 

برای افزودن تصویر می‌توانید از syntax زیر استفاده کنید:

![camelCase](https://camelcase.ir/wp-content/uploads/cropped-logo-2-e1589836615143.png)

![Alt Text](url)

خب در مثال بالا دیدید که این دستور دو بخش دارد:

• Alt‌: این بخش وقتی که تصویر مورد نظر مسیر غلطی داشته و یا فایل تصویر حذف بشود، نمایش داده می‌شود.
• Url‌: آدرس تصویر مورد نظر شما.

افزودن لینک در markdown 

برای افزودن لینک در markdown از syntax زیر استفاده کنید:

[camelCase](https://camelcase.ir/)

در نگارش مشخص شده در مثال بالا می‌بینید که ابتدا یک کلمه داخل زوج کاراکتر [] مشخص شده است که در واقع کلمه‌ی لینک شده را مشخص می‌کند. سپس در جلوی آن و دقیقا بدون فاصله در یک زوج کاراکتر () آدرس یا url مورد نظر شما مشخص می‌شود.

افزودن نقل قول یا Blockquotes در markdown 

نقل قول‌ها متن‌هایی هستند که از طرف شخص دیگری گفته شده است که معمولا یا آن فرد خیلی شناخته شده است یا اگر شناخته نشود حتما فرد مورد نظر را مشخص می‌کنند. البته نقل قول‌ها کاربردهای زیادی دارند مثلا در ابتدای این متنی که در حال مطالعه هستید روش رفع تحریم گیت هاب برای شما به صورت نقل قول اضافه شده است. برای افزودن نقل قول یا blockquotes در markdown از syntax زیر استفاده کنید:

> Success is a lousy teacher. It seduces smart people into thinking they can't lose.

متن بالا یک نقل قول از بیل گیتس معروف است که در مثال بالا آمده است. در ارتباط با نقل قول در وردپرس بیش‌تر بخوانید.

افزودن کد درون خطی (برای نمایش) یا inline code در markdown 

برای افزودن کد درون خطی یا inline code در markdown از syntax زیر استفاده کنید:

The HTML `<p>` element represents a paragraph.

با توجه به مثال بالا برای استفاده از inline code از کاراکتر ` استفاده می‌شود.

نمایش کد چندخطی(کدهای زبان‌های برنامه نویسی) در MARKDOWN

کدهای چندخطی می‌توانند کدهایی از برنامه‌های شما بوده که قصد دارید درباره ی آن‌ها توضیحی بنویسید. نوع نوشتن کدچندخطی در markdown به شکل زیر است:

```public function printName($name)
{
	$name = ltrim(rtrim($name));
	$name = 'your name is ' . $name;
	echo $name;
}

```

اگر با زبان برنامه نویسی PHP آشنایی ندارید احتمالا متوجه کد بالا نمی‌شوید البته این کد بسیار ساده است و موضوع بحث ما نیست که در مورد آن توضیحی بدهیم؛ این کد تنها برای نمایش مثال در مورد افزودن کد چندخطی در markdown استفاده شده است.

اگر در نگارش بالا خطایی رخ داده است یا مشکلی از نظر شما دیده می‌شود در بخش نظرات برای ما بنویسید. امیدوارم این نوشته مورد قبول شما واقع شود.