786
سلام! علیرضا هستم. بعد از یه مدت طولانی با یه موضوع خیلی جالب و کاربردی اومدم! خیلی از ما برنامه نویس ها با گیت هاب کار میکنیم.برای مدیریت و توسعه پروژه های اوپن سورس ، مشارکت در بقیه پروژه ها و... . ولی یکی از اساسی ترین اجزاء هر پروژه ای نوشتن فایل README.md هست! بدون این فایل پروژه شما ناقصه!
این فایل توضیحات اصلی پروژه شماست! هرکسی که وارد صفحه پروژه میشه پایین تر از فایل ها این توضیحات رو میبینه. و اگر فایل README رو درست ننوشته باشید یا اصلا ننوشته باشید خیلی از کسایی که پروژه شما رو میبینن متوجه کارایی پروژه نمیشن!پس به این دلیل این فایل مهمه.اما این فایل یه فرق مهم با بقیه فایل های متنی مهم داره.
این فایل در مقایسه با فایل های یک فرمت دیگه (مثلا word) یه فرق مهم داره! گیت هاب ابزاری برای بولد یا ایتالیک کردن نداره! و کارهای استایلینگ با سینتکس مخصوص این فایل انجام میشه! زبان این فایل ، زبان نشانه گذاری Markdown هست! و سینتکس این زبان خیلی ساده ست.پس بریم یادش بگیریم!
موقع ساخت Repository جدید حتما تیک قسمت Add a README file رو بزنید! اگر توی پروژه قبلیتون این کار رو نکردید ، خودتون دستی این فایل رو درست کنید!
توی گیت هاب ترجیحا این فایل رو edit کنید چون preview هم داره و میتونید تغییراتتون رو قبل از commit ببینید!
اولین خط توی فایل اسم پروژه هست!با استفاده از # (قبل متن) میتونید متن ها رو بولد کنید! برای عنوان پروژه مثل زیر عمل کنید!
#Title!
تعداد # ها میتونه از 1 عدد تا 6 عدد باشه. ولی هرچقدر تعداد مربع ها بیشتر بشه اندازه کوچکتر میشه.مثلا برای عنوان قسمت TODO list اینجوری عمل کنید:
##TODO list
زیر عنوان شروع به نوشتن توضیحات کنید. بعضی جاها نیاز هست که هایپر لینک (اضافه کردن لینک به متن) اضافه کنیم.برای این کار مثل زیر عمل کنید:
My blog in virgool is [Alirezadigi](https://virgool.io/@alirezadigi)
در کروشه ، متنی که میخواهید هایپر لینک بشه رو بذارید و در پرانتز ، لینک رو قرار بدید!
بعضی وقت ها نیاز هست که یک تکه‌کد توی توضیحات قرار بدید! یا کد های ترمینال برای نصب پروژه رو بزارید!برای این مواقع مثل زیر عمل کنید:
```bash pip install foobar
``` ```python import foobar ```
این علامت رو ( ` ) میتونید با زدن دکمه کنار 1 یا دکمه زیر Esc (ممکنه با توجه به کیبورد و سیستم عاملتون جای دکمه فرق کنه) تایپ کنید. بعد از 3 تا ` باید اسم زبان رو بنویسید تا استایل اون زبان رو به کدتون بده (رنگی کردن توابع و ...) .اگر اسم زبان رو ننویسید رنگ همه کد مشکی میشه! کد که تموم شد باز هم 3 تا ` بزارید!
برای بولد و ایتالیک کردن یک کلمه یا جمله (چند خط رو بالاتر توضیح دادم) مثل زیر عمل کنید:
**This is bold text** #bold *This text is italicized* #italic
برای وارد کردن لیست هایی مثل TODO list ها مثل زیر عمل کنید:
- [x] Complete! - [ ] Not complete!
بین کروشه ها اسپیس بزنید.زمانی که اون قسمت پروژه درست شد توی کروشه جای اسپیس ، x بذارید.
برای لیست های معمولی هم مثل زیر عمل کنید:
- item1 - item2
برای تایپ ایموجی هم از این سایت ، کد ایموجی مد نظرتون رو کپی کنید (کدی که با : شروع و تموم میشه) و هرجای متن که خواستید ازش استفاده کنید.
دیگه تقریبا بیشتر markdown رو یاد گرفتید! البته مطالب دیگه هم هست ولی من سعی کردم پرکاربرد ترین سینتکس ها رو بهتون توضیح بدم.بقیه سینتکس رو میتونید توی منابع یاد بگیرید! امیدوارم از این نوشته لذت برده باشید. تا نوشته بعدی خدانگهدار!
