آموزش

راهنمای Markdown

۱۴۰۴/۰۹/۱۰۸ دقیقهنویسنده: تیم لیستان

قالب‌بندی متن یعنی آراستن و خوش‌نمایی نوشته با شیوه‌هایی همچون پررنگ‌کردن واژه‌ها، برجسته‌کردن عبارت‌ها یا تغییر اندازه‌ی فونت؛ روشی که کمک می‌کند خواننده پیام را سریع‌تر و دقیق‌تر دریافت کند، روی نکات کلیدی تمرکز بیشتری داشته باشد و هنگام مطالعه حس بهتری تجربه کند. ساختارمندی متن یعنی نظم‌دادن و بخش‌بندی محتوا با بهره‌گیری از تیتر و زیرتیتر، لیست‌های شماره‌دار و دیگر ابزارهای دسته‌بندی؛ فرایندی که باعث می‌شود متن دارای مسیر خوانش روشن باشد، خواننده آن را مرحله‌به‌مرحله دنبال کند، دچار آشفتگی نشود و در نهایت بهتر به عمق موضوع برسد. این دو اصل هنگام نوشتن یادداشت‌ها، پیام‌ها، توضیحات، مقاله‌ها یا هر شکل دیگری از متن، به ما کمک می‌کنند منظور را شفاف‌تر منتقل کنیم، نوشته را حرفه‌ای‌تر ارائه دهیم، مخاطب را بیشتر درگیر کنیم و در نتیجه تأثیرگذاری پیام را افزایش دهیم.

اگر از ویرایشگر Word استفاده کرده باشید، می‌دانید که باید مدام به ماوس دست بزنید، دکمه‌ها را کلیک کنید، و منتظر بمانید تا قالب‌بندی اعمال شود. این کار کند است و حواس شما را از نوشتن پرت می‌کند. اگر هم بخواهید متن را در جاهای مختلف استفاده کنید احتمالاً باید دوباره همه چیز را قالب‌بندی کنید. اینجاست که Markdown وارد می‌شود. Markdown به شما اجازه می‌دهد با استفاده از نمادهای ساده و آشنا (مثل # برای تیتر و * برای تأکید) متن‌های ساختارمند بنویسید. هم خوانا است و هم می‌توانید آن را در هر جایی کپی کنید و دوباره استفاده کنید.


شروع با ساختار

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

# عنوان اصلی مقاله شما
## بخش اول: مقدمه
### زیربخش اول
## بخش دوم: محتوای اصلی

همین! دیگر نیازی نیست به ماوس دست بزنید یا دکمه‌ای را کلیک کنید. فقط بنویسید و ساختار خودش ایجاد می‌شود. فقط یادتان باشد بین # و متن تیتر یک فاصله بگذارید، و از تیتر سطح ۱ فقط یک بار برای عنوان اصلی استفاده کنید.


نوشتن طبیعی

حالا که ساختار دارید، می‌خواهید شروع به نوشتن کنید. در Markdown، نوشتن پاراگراف‌ها خیلی ساده است—فقط بنویسید. وقتی می‌خواهید پاراگراف جدیدی شروع کنید، یک خط خالی بگذارید:

این پاراگراف اول است. می‌توانید هر چیزی که می‌خواهید بنویسید.

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

همین! نیازی به فشردن Enter دو بار یا استفاده از دکمه‌های خاص نیست. فقط یک خط خالی کافی است.


تأکید روی نکات مهم

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

این نکته **خیلی مهم** است.

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

برای متن کج، یک ستاره کافی است:

این عبارت *تأکیدی* است.

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

و اگر بخواهید چیزی را خط بزنید—مثلاً برای نشان دادن تغییرات یا حذف—از دو تیلدا استفاده کنید: ~~متن خط خورده~~ که به این شکل می‌شود: متن خط خورده.


سازماندهی با لیست‌ها

وقتی می‌خواهید نکات را لیست کنید یا مراحل را نشان دهید، لیست‌ها به کمک می‌آیند. در Markdown، دو نوع لیست دارید: لیست ساده و لیست شماره‌دار. برای لیست ساده—مثلاً وقتی می‌خواهید ویژگی‌های یک محصول را لیست کنید—از علامت خط تیره استفاده کنید:

ویژگی‌های این محصول:

- سریع است
- ساده است
- رایگان است

که به این شکل نمایش داده می‌شود:

  • سریع است
  • ساده است
  • رایگان است

اما اگر می‌خواهید مراحل را به ترتیب نشان دهید (مثلاً دستورالعمل نصب) از لیست شماره‌دار استفاده کنید:

مراحل نصب:

1. فایل را دانلود کنید
2. آن را باز کنید
3. دستورات را اجرا کنید

که به این شکل نمایش داده می‌شود:

  1. فایل را دانلود کنید
  2. آن را باز کنید
  3. دستورات را اجرا کنید

ارتباط با دنیای بیرون

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

برای اطلاعات بیشتر به [وب‌سایت لیستان](https://listan.ir) مراجعه کنید.

که به این شکل نمایش داده می‌شود: برای اطلاعات بیشتر به وب‌سایت لیستان مراجعه کنید.

اگر می‌خواهید آدرس را مستقیماً نمایش دهید (بدون متن لینک) آن را در علامت کوچکتر و بزرگتر قرار دهید:

<https://listan.ir>

برای تصاویر، همان ساختار لینک را استفاده کنید، اما در ابتدا یک علامت تعجب اضافه کنید:

![توضیح تصویر](https://example.com/image.jpg)

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


نقل‌قول و جدا کردن بخش‌ها

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

> این یک نقل‌قول مهم است که می‌خواهید توجه خواننده را جلب کند.

که به این شکل نمایش داده می‌شود:

این یک نقل‌قول مهم است که می‌خواهید توجه خواننده را جلب کند.

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

---

که یک خط جداکننده ایجاد می‌کند.


نوشتن کد

اگر برنامه‌نویس هستید یا می‌خواهید دستورات را در متن نشان دهید، Markdown راه‌های ساده‌ای برای نمایش کد دارد. برای کد تک‌خطی (مثلاً نام یک دستور یا متغیر) آن را بین یک جفت بک‌تیک قرار دهید:

برای نصب از `npm install` استفاده کنید.

که به این شکل نمایش داده می‌شود: برای نصب از npm install استفاده کنید.

اما اگر می‌خواهید یک بلوک کد کامل نشان دهید—مثلاً یک تابع یا چند خط کد—از سه بک‌تیک استفاده کنید و زبان را هم مشخص کنید:

```javascript
function greet(name) {
  return "سلام " + name;
}
```

که به این شکل نمایش داده می‌شود:

function greet(name) {
  return "سلام " + name;
}

مشخص کردن زبان باعث می‌شود کد با رنگ‌بندی مناسب نمایش داده شود و خواندن آن راحت‌تر شود.


سازماندهی داده‌ها با جداول

گاهی می‌خواهید داده‌ها را به صورت جدول نمایش دهید—مثلاً مقایسه ویژگی‌ها یا نمایش اطلاعات ساختاریافته. در Markdown، جداول با استفاده از خط عمودی و خط تیره ساخته می‌شوند:

| ویژگی | نسخه رایگان | نسخه پولی |
|--------|-------------|-----------|
| ذخیره‌سازی | ۵ گیگابایت | نامحدود |
| پشتیبانی | ایمیل | ۲۴/۷ |

که به این شکل نمایش داده می‌شود:

ویژگینسخه رایگاننسخه پولی
ذخیره‌سازی۵ گیگابایتنامحدود
پشتیبانیایمیل۲۴/۷

خط دوم—با خط تیره‌ها—فقط برای جدا کردن سرستون‌ها از داده‌ها است. بعد از آن، هر خط یک ردیف جدول است.


همه چیز کنار هم

حالا که با ابزارهای اصلی Markdown آشنا شدید، بیایید ببینیم چطور همه اینها کنار هم یک مقاله کامل می‌سازند:

# راهنمای استفاده از Markdown

## چرا Markdown؟

Markdown یک روش **ساده** و *کارآمد* برای نوشتن متن‌های ساختارمند است.

## مزایای استفاده

- سریع است
- خوانا است
- قابل استفاده در همه جا

## شروع کار

برای شروع، فقط بنویسید:

```markdown
# عنوان شما
```

> یادتان باشد: تمرین باعث می‌شود بهتر شوید.

برای اطلاعات بیشتر به [وب‌سایت لیستان](https://listan.ir) مراجعه کنید.

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


چرا Markdown را یاد بگیریم؟

حالا که با نحوه کار Markdown آشنا شدید، شاید بپرسید چرا باید آن را یاد بگیرید. پاسخ ساده است: چون Markdown همه‌جا استفاده می‌شود.

اگر در GitHub پروژه‌ای دارید، README شما با Markdown نوشته می‌شود. اگر می‌خواهید در Reddit یا Stack Overflow پست بگذارید، از Markdown استفاده می‌کنید. بسیاری از بلاگ‌ها و سیستم‌های مدیریت محتوا از Markdown پشتیبانی می‌کنند. حتی برخی از پیام‌رسان‌ها و ابزارهای همکاری تیمی هم از Markdown استفاده می‌کنند.

اما مهم‌تر از همه، Markdown به شما آزادی می‌دهد. می‌توانید متن را در یک ویرایشگر ساده بنویسید و بعد آن را در هر جایی که می‌خواهید استفاده کنید. نیازی نیست نگران قالب‌بندی باشید—متن شما همیشه خوانا می‌ماند، حتی اگر ابزار خاصی مانند لیستان برای نمایش آن نداشته باشید.

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


شروع کنید

شما برای استفاده از لیستان یازی به یادگیری Markdown ندارید. لیستان بدون Markdown هم کار می‌کند. به‌راحتی یادداشت‌هایتان را بنویسید، ویرایش کنید و به‌صورت عادی و بدون نیاز به هیچ نماد یا دستور خاصی از امکانات استفاده کنید.

Markdown یک امکان اضافی برای کسانی است که می‌خواهند نوشته‌هایشان را سریع‌تر و حرفه‌ای‌تر قالب‌بندی کنند. اگر این راهنما را خوانده‌اید و علاقه‌مند شدید، می‌توانید از همین امروز شروع کنید. در ابتدا ممکن است فراموش کنید که از چه نمادی استفاده کنید، اما نگران نباشید، این طبیعی است. با تمرین، به مرور همه چیز برایتان عادی می‌شود.

اما اگر Markdown را یاد نگرفتید یا نخواستید از آن استفاده کنید، هیچ مشکلی نیست. لیستان برای شما طراحی شده تا بتوانید بدون هیچ دانش قبلی و به‌راحتی از آن استفاده کنید.