محمدمهدی بخشی
محمدمهدی بخشی
خواندن ۶ دقیقه·۴ سال پیش

آموزش Markdown؛ چیزی که امیدوارم بتوان با آن پایان‌نامه نوشت!

اول بگم من این متن رو سرسری نوشتم و خیلی روش متمرکز نشدم. بیشتر برای تست بنویس.آنلاین بود ولی دیدم بد نیست توی ویرگول هم منتشرش کنم. به بنویس.آنلاین سر بزنید و خروجی چیزایی که اینجا می‌گم رو اونجا در لحظه ببینید و از زندگی لذت ببرید :)).

آها، راستی! غلطی، خطایی یا اشتباهی دیدید، گذشت کنید و کظم غیظ؛ البته برای تصحیحش بهم اطلاع بدید. اگه چیزی نامفهوم بود توی نظرات ازم بپرسید.

نماد مارک‌داون
نماد مارک‌داون



افتتاحیه:

به قول وییکی‌پدیا؛

مارک‌داون (به انگلیسی: Markdown) عنوان یک زبان قالب‌بندی متن و نیز یک ابزار تبدیل متن به اچ‌تی‌ام‌ال است که اجازه می‌دهد کاربران متن را به صورت ساده وارد کنند و سپس به صورت خودکار آن را به متن غنی تبدیل نمایند.[۵]

و کلیت قضیه اینه که شما یه متنی رو می‌نویسید و با مارک‌داون می‌گید چه شکلی این متن نمایش داده بشه یا تفسیر بشه؛ همین.

پاراگراف‌بندی:

خب! برای شروع بگم که توی مارک‌داون جداکردن هر پاراگراف با یه خط فاصله اتفاق میوفته. یعنی:

پاراگراف اول ... پاراگراف دوم ...

و برای اینکه فرمت یه متن تبدیل بشه به متن ساده (مثل همین چیزی که می‌خونید) باید از همین روش خط فاصله استفاده کنید که بین متن‌ها تداخلی پیش نیاد.

کاراکتر فرار:

یه موقع خواستید که مارک‌داون اعمال نشه، قبل علامت مارک‌داون یه / بزارید. مثلا استفاده از دو تا ستاره داخل متن، متن رو کج می‌کنه ولی من الان داخل دو تا ستاره \* متن کج‌نشده \* می‌نویسم.

عنوان:

بیایید با هم ببینیم چجوری میشه تیتر نوشت. تیترها یا همون عنوان‌های خودمون، به ترتیب درشتی و بزرگی اندازه قلم، به شش مورد تقسیم می‌شن که با تعداد هشتگ‌های قبل متن، ترتیبشون مشخص میشه:

# تیتر یکم (بزرگترین و درشت‌ترین) ## تیتر دوم ### تیتر سوم #### تیتر چهارم ##### تیتر پنجم ###### تیتر ششم (کوچک‌ترین و نازک‌ترین)

بعد از این که برای نوشته خودتون عنوان‌ها رو قرار دادید و یه شمای خوشگل کلی از کارتون به دست آوردید، می‌ریم سراغ شکل‌دهی به نوشته‌ها و تغییر فرمت اون‌ها:

فرمت‌دهی:

**با دو تا دوستاره، درشت می‌نویسیم.**

*با دو تا تک‌ستاره* یا _دو تا تک‌زیرخط کج می‌نویسیم._

~~با دو تا دومد (در مجموع چهار مد) روی نوشته خودمون یه خط می‌کشیم.~~ حواستون باشه که مدها باید به جمله چسبیده باشن. الان مثلا؛ ~~ کلمه ~~ کار نمی‌کنه!

اگه بخوایم یه کاری کنیم متن ما به شکل کدی نشون داده بشه باید اونو بین `دو تا بک‌تیک یا این خط کوچیکای کج` بزاریم. نتیجه این میشه که اون قسمت خاص، به شکل کدی نشون داده میشه.

دیگه چی داریم؟

نقل قول:

با گذاشتن علامت > اول متن، می‌تونیم نقل قول بنویسیم.

> در زندگي زخمهايي هست كه مثل خوره در انزوا روح را اهسته مي خورد و مي تراشد. > (صادق هدایت)

که خروجیش به این شکله:

در زندگي زخمهايي هست كه مثل خوره در انزوا روح را اهسته مي خورد و مي تراشد.
(صادق هدایت)

فهرست ترتیبی:

باید اول هر خط، یه شماره، یه نقطه و یه فاصله بنویسم و بعد متنی که می‌خوایم داخل فهرست نشون داده بشه رو بنویسیم:

1. مورد اول 2. مورد دوم 3. مورد سوم

فهرست بدون ترتیب

باید اول هر خط، یه خط تیره یا ستاره و یه فاصله بنویسم و بعد متنی که می‌خوایم داخل فهرست نشون داده بشه رو بنویسیم:

- یه چیزی - یه چیز دیگه - یه چیز خیلی دیگه

فهرست TODO:

گذاشتن فهرست TODO یا فهرستی که تیک می‌خوره.

عین فهرست بدون ترتیب می‌نویسید فقط اولش یه تعداد [] می‌زارید. اگه داخل این کروشه‌ها فضای خالی باشه (یعنی باید حتما یه اسپیس اون وسط باشه) عین حالتیه که قراره انجام بشه. اگه x بزاریم یعنی تیک خورده. این قسمت آپشنای دیگه هم داره ولی اونا همه‌جا کار نمی‌کنن.

- [x] این کار رو انجام دادم. - [ ] دارم روی این کار می‌کنم. - [ ] هنوز انجامش ندادم.

فهرست ترکیبی:

میشه از علامتای فهرست‌های ترکیبی و ترتیبی، با هم استفاده کرد.

1. مورد اول - یه چیزی 2. مورد دوم! - [ ] مورد انجام‌نشده. - [x] مورد انجام‌شده.

خط افقی:

با نوشتن --- یا *** یا ___ می‌تونیم یه خط افقی بکشیم.

لینک:

برای نوشتن لینک باید اول یه [] باز کنیم و داخلش اسم لینک رو بزاریم و بعد از اون یه () باز کنیم و آدرس لینک رو بزاریم؛ مثلا:

[لینک](https://www.example.com)

اگه بخوایم به لینکمون یه سری توضیحات اضافه کنیم که مثلا وقتی موس می‌ره روی لینک، یه پاپ‌آپ باز شه و توضیحات رو نشون بده به این شکل عمل می‌کنیم. همون []() رو می‌نویسیم، فقط بعد از گذاشتن آدرس لینک، یه فاصله می‌زاریم و داخل دو تا دبل‌کوتیشن یا «"» توضیحات رو می‌نویسم؛ مثلا:

[موست رو بیار روم.](https://example.com &quotلینک توضیح‌دار&quot)

عکس:

حالا اگه قرار باشه عکس اضافه کنیم هم عین همون لینک عمل می‌کنیم با این تفاوت که قبل از [] و همون اول باید یه ! بزاریم. راستی چیزی که داخل [] میاد، مثل کپشنه و اگه عکس دانلود نشه، این متن به جای عکس نشون داده میشه:

![alt text](https://rahyafteha.ir/wp-content/uploads/2020/04/Shahid-Chamran-H-scaled.jpg)

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

[توضیح عکس][لینک]

و در قسمت مراجع باید لینک رو تعریف کرد:

[لینک]:http://uupload.ir/files/fx26_%D9%84%D9%88%DA%AF%D9%88_%D8%AE%D9%86%D8%AF%D9%88%D8%A7%D9%86%D9%87.png

جدول:

خب. حالا اگه قرار باشه جدول بسازیم چی؟ برای ساختن جدول باید به شکل زیر اون رو بسازید. شکل گویاست ولی توضیحش اینه که توی خط اول باید بین دو تا خط مستقیم یعنی کاراکتر «|» عنوان ستون‌ها رو مشخص کنید. برای جدا کردن ستون‌ها هم از همین کاراکتر استفاده میشه.

توی خط‌های بعدی هم مثل همون خط اول ستون‌ها رو مشخص می‌کنید با این تفاوت که خط دوم (زیر عنوان‌ها) باید با یک (یا بیشتر) خط تیره یا همین کاراکتر «-» پر بشه تا مشخص بشه عنوان‌ها از سطرها جدا شدن. خط‌های سوم به بعد، میشن سطرهای جدول.

| عنوان اولی (مثلا اسم) | عنوان دومی (مثلا فامیل) | | - | - | | حمید | کاظمی | | کاظم | حمیدی |

اینم از جدول.

کدنویسی داخل متن:

مورد بعدی! چجوری کد بنویسیم؟ کاری نداره که. کد رو بین دو تا سه‌بک‌تیک یا «```» بزار. نکته مهم اینه که بهتره کدها از سه‌تا بک‌تیک جدا بشن، یعنی بینشون یه خط فاصله باشه. یعنی به این شکل:

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

تو خط‌های بعدی یه مشت کد بنویسم.

توی خط آخر هم فقط سه تا بک‌تیک بزاریم.

مثلا اگه این رو بنویسیم:

```javascript { &quotfirstName&quot: &quotJohn&quot, &quotlastName&quot: &quotSmith&quot, &quotage&quot: 25 } ```

خروجیش میشه این:

{ &quotfirstName&quot: &quotJohn&quot, &quotlastName&quot: &quotSmith&quot, &quotage&quot: 25 }

مرجع‌دهی

برای نوشتن مرجع (منظور از مرجع، علامت مرجع داخل متن اصلی است)، باید به این شکل عمل کنیم که دو تا [] کنار هم می‌نویسیم. توی اولی شکل ظاهری مرجع نشون داده میشه؛ مثلا، شما می‌تونی داخل اولی به شکل IEEE مرجع رو مشخص کنی:

[[1]][اکبری]

یا مثلا سبک APA:

[(اکبری، ۱۳۹۵)][1]

دومین [] برای تعیین لینک به مرجع در قسمت مراجع هست که آخر هر مقاله میاد. داخلش رو می‌تونید با عدد یا یه متن پر کنید و کار این محتوا، اینه که مرجع رو به قسمت مراجع مرتبط کنه.

خب حالا چجوری قسمت مراجع رو باید پر کرد؟ این شکلی:

باید اول یه [] بزارید و بعد یه دو نقطه («:») بزارید. داخل [] رو با همون عددی که توی قسمت دوم مرجع دادیم، پر می‌کنیم. مثلا (قسمت لینک‌شده همون چیزی هست که داخل [] دوم نوشتیم):

[1]: درآمدی بر نسبت عرضه و تقاضا،‌ ا. اکبری، ۱۳۹۵، انتشارات دانشگاه تهران. [اکبری]: درآمدی بر نسبت عرضه و تقاضا،‌ ا. اکبری، ۱۳۹۵، انتشارات دانشگاه تهران.

پانویس:

برای گذاشتن پانویس (فوت‌نوت)، باید به این شکل عمل کنیم که ...

اون‌جایی که قراره عدد پانویس به شکل بالا‌نویس گذاشته بشه، داخل [] اول یه دونه کلاهک یا ^ می‌زاریم بعد عدد مربوط بهش رو.

بعد توی اخر صفحه هم که یه قسمت پا‌نویس رو در نظر می‌گیرم باید همون علامت قبلی رو کپی کنیم و ببریم اون ته بنویسیمش. فک کنم بد توضیح دادم، پس مثال قابل فهمیدن تره:

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

آقای نلسون ماندلا[^1] مرد خوبی بود.

بعد می‌ریم داخل قسمت پانویس متنمون و پانویس رو این شکلی تعریف می‌کنیم:

[^1]- Nelson mandela

اینم از پانویس.

اختتامیه:

خب. همینا دیگه. مارک‌داون تا یه توی ویرگول هم کار می‌کنه، میشه ازش بهره برد!

چیت‌شیت آموزشی گیت‌هابم اینه:

https://guides.github.com/pdfs/markdown-cheatsheet-online.pdf

markdownمارکداوننویسندگیhtmlگیتهاب
یه برنامه نویس که قراره دنیا نویسی کنه!
شاید از این پست‌ها خوشتان بیاید