راهنمای مقدماتی مارک‌داون

نوشته حسین بهنودی در ۲۴ تیر ۱۳۹۸

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

عناوین (Headings)

برای ایجاد عنوان، قبل از کلمه یا عبارت، از یک تا شش علامت هشتگ (#) اضافه کنید. تعداد هشتگ‌هایی که استفاده می‌کنید نشان‌دهنده سطح عنوان است.

مارک‌داون:

# عنوان ۱
## عنوان ۲
### عنوان ۳
#### عنوان ۴
##### عنوان ۵
###### عنوان ۶

خروجی رندر شده:

عنوان ۱

عنوان ۲

عنوان ۳

عنوان ۴

عنوان ۵
عنوان ۶
نکته: همیشه یک فاصله بین علامت # و نام عنوان قرار دهید. برای مثال # عنوان صحیح است و #عنوان (بدون فاصله) ممکن است در برخی پردازشگرها کار نکند.

پاراگراف‌ها (Paragraphs)

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

مارک‌داون:

من عاشق نوشتن مستندات با مارک‌داون هستم. خواندن این فرمت بسیار راحت است.

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

خروجی رندر شده:

من عاشق نوشتن مستندات با مارک‌داون هستم. خواندن این فرمت بسیار راحت است.

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

نکته: مگر اینکه پاراگراف در یک لیست باشد، خطوط را با فاصله (Space) یا تب (Tab) تو‌رفتگی ندهید.

شکستن خط (Line Breaks)

برای ایجاد یک شکست خط (رفتن به سر خط جدید) که معادل تگ <br> است، خط را با دو یا چند فاصله (Space) به پایان برسانید و سپس اینتر بزنید.

مارک‌داون:

این اولین خط است.  
و این خط دوم است.

خروجی رندر شده:

این اولین خط است.
و این خط دوم است.

اگر دو فاصله را در انتهای خط نگذارید، مارک‌داون خط بعدی را در ادامه همان خط قبلی نمایش می‌دهد (چون در HTML اینترهای معمولی نادیده گرفته می‌شوند).


تأکید (Emphasis)

شما می‌توانید با ضخیم (Bold) یا کج (Italic) کردن متن، به آن تأکید اضافه کنید.

ضخیم (Bold)

برای ضخیم کردن متن، قبل و بعد از کلمه یا عبارت، دو ستاره ** یا دو خط زیرین __ قرار دهید.

مارک‌داون:

من عاشق **غذای ایرانی** هستم.
من عاشق __غذای ایرانی__ هستم.

خروجی رندر شده:

من عاشق غذای ایرانی هستم.

من عاشق غذای ایرانی هستم.

کج (Italic)

برای کج کردن متن، قبل و بعد از کلمه یا عبارت، یک ستاره * یا یک خط زیرین _ قرار دهید.

مارک‌داون:

این متن *بسیار مهم* است.
این متن _بسیار مهم_ است.

خروجی رندر شده:

این متن بسیار مهم است.

این متن بسیار مهم است.

ضخیم و کج همزمان

برای اعمال همزمان هر دو حالت، از سه ستاره *** یا سه خط زیرین ___ استفاده کنید.

مارک‌داون:

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

خروجی رندر شده:

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


نقل‌قول‌های بلوکی (Blockquotes)

برای ایجاد نقل‌قول بلوکی، یک علامت > در ابتدای پاراگراف اضافه کنید.

مارک‌داون:

> بنی‌آدم اعضای یکدیگرند
> که در آفرینش ز یک گوهرند

خروجی رندر شده:

بنی‌آدم اعضای یکدیگرند
که در آفرینش ز یک گوهرند

نقل‌قول‌های تودرتو

می‌توانید نقل‌قول‌ها را درون هم قرار دهید. برای این کار از دو علامت >> استفاده کنید.

مارک‌داون:

> این پاراگراف اول نقل‌قول است.
>
> > این یک نقل‌قول درون نقل‌قول دیگر است.
>
> بازگشت به سطح اول نقل‌قول.

خروجی رندر شده:

این پاراگراف اول نقل‌قول است.

این یک نقل‌قول درون نقل‌قول دیگر است.

بازگشت به سطح اول نقل‌قول.


لیست‌ها (Lists)

شما می‌توانید آیتم‌ها را در لیست‌های مرتب (شماره‌دار) و نامرتب دسته‌بندی کنید.

لیست‌های مرتب (Ordered Lists)

برای ایجاد لیست مرتب، آیتم‌ها را با اعداد و نقطه 1. شروع کنید. لازم نیست اعداد حتماً به ترتیب باشند، اما بهتر است با عدد ۱ شروع کنید.

مارک‌داون:

1. نان سنگک
2. پنیر تبریز
3. گردو
4. چای لاهیجان

خروجی رندر شده:

  1. نان سنگک
  2. پنیر تبریز
  3. گردو
  4. چای لاهیجان

لیست‌های نامرتب (Unordered Lists)

برای ایجاد لیست نامرتب، قبل از آیتم‌ها از خط فاصله -، ستاره * یا علامت جمع + استفاده کنید.

مارک‌داون:

- یادگیری HTML
- یادگیری CSS
- یادگیری JavaScript

خروجی رندر شده:

  • یادگیری HTML
  • یادگیری CSS
  • یادگیری JavaScript

کد (Code)

برای نمایش کلمات به عنوان کد در میان یک جمله، آن را در میان «بک‌تیک» (`) قرار دهید.

مارک‌داون:

در لینوکس برای دیدن لیست فایل‌ها از دستور `ls -la` استفاده کنید.

خروجی رندر شده:

در لینوکس برای دیدن لیست فایل‌ها از دستور ls -la استفاده کنید.

بلوک‌های کد (Code Blocks)

برای ایجاد بلوک کد، از سه بک‌تیک ``` استفاده کنید. معمولاً خطوط را با ۴ فاصله یا یک تب (Tab) تورفتگی می‌دهید.

مارک‌داون (با ۴ فاصله):

```
<html>
    <head>
    </head>
</html>
```

خروجی رندر شده:

<html>
    <head>
    </head>
</html>

خطوط افقی (Horizontal Rules)

برای ایجاد یک خط افقی، از سه یا تعداد بیشتری ستاره ***، خط فاصله --- یا خط زیرین ___ در یک خط جداگانه استفاده کنید.

مارک‌داون:

***

---

_________________

خروجی رندر شده:





لینک‌ها (Links)

برای ایجاد لینک، متن لینک را در براکت [ ] و آدرس URL را بلافاصله در پرانتز ( ) قرار دهید.

مارک‌داون:

از [موتور جستجوی گوگل](https://www.google.com) برای یافتن پاسخ استفاده کنید.

خروجی رندر شده:

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

افزودن عنوان (Title)

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

مارک‌داون:

[وب‌سایت ورزش ۳](https://www.varzesh3.com "اخبار ورزشی ایران و جهان")

تصاویر (Images)

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

مارک‌داون:

![کوه دماوند](https://upload.wikimedia.org/wikipedia/commons/thumb/1/14/Damavand_in_winter.jpg/320px-Damavand_in_winter.jpg)

خروجی رندر شده:

کوه دماوند

گریز دادن کاراکترها (Escaping Characters)

اگر می‌خواهید کاراکتری را نمایش دهید که در فرمت‌دهی مارک‌داون استفاده می‌شود (مثل * یا #) و نمی‌خواهید آن کاراکتر باعث تغییر فرمت متن شود، باید قبل از آن یک علامت بک‌اسلش \ قرار دهید.

مارک‌داون:

\* این متن کج نیست و ستاره‌ها نمایش داده می‌شوند \*

خروجی رندر شده:

* این متن کج نیست و ستاره‌ها نمایش داده می‌شوند *