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

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

مفهوم Markdown یک نحوه ی سبک نوشتاری برای ایجاد مستندات می باشد؛ این نوع نوشتار در گیت هاب بسیار کاربردی است.

در این نوشته به بررسی نوع نوشتن یا syntax در Markdown می پردازیم.

از Markdown می توانید در فایل readme.md استفاده کنید.

این نوشته را با ما بخوانید.

 

markdown چیست؟

مارک داون یک نوع نوشتار برای اسناد است که به سادگی قابل نوشتن است؛

در این نوع نوشتار شما برای تعریف تصویر، لینک، لیست ها، پاراگراف ها، عنوان ها و … می توانید به سادگی کد بنویسید.

البته نمی توان به آن مفهوم کدنویسی را داد زیرا اجرا نمی شود و تنها یک زبان نشانه گذاری می باشد.

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

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

 

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

 

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

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

 

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

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

در markdown هم این موضوع موجود است.

با کمک کاراکتر هشتگ یا # می توانید این عنوان ها را داشته باشید.

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

 

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

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

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

 

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

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

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

 

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

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

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

  1. One
  2. Two
  3. Three
    ۱. Item Three-1
    ۲. 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

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

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

 

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

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

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

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

 

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

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

در نگارش مشخص شده در مثال بالا می بینید که ابتدا یک کلمه داخل زوج کاراکتر [] مشخص شده است که در واقع کلمه ی لینک شده را مشخص می کند؛

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

 

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

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

البته نقل قول ها کاربردهای زیادی دارند مثلا در ابتدای این متنی که در حال مطالعه هستید روش رفع تحریم گیت هاب برای شما به صورت نقل قول اضافه شده است.

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

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

در ارتباط با نقل قول در وردپرس بیشتر بخوانید.

 

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

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

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

 

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

نوع نوشتن کدچندخطی در markdown به شکل زیر است:

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

 

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

امیدوارم این نوشته مورد قبول شما واقع شود.

موفق باشید.

برای امتیاز به این نوشته کلیک کنید!
[کل: ۱ میانگین: ۵]
با دوستانتان به اشتراک بگذارید

دیدگاهتان را بنویسید

نشانی ایمیل شما منتشر نخواهد شد. بخش‌های موردنیاز علامت‌گذاری شده‌اند *

*

code