راهنمای نحو Markdown

نحو ضروری برای قالب‌بندی اسناد شما

نمای کلی

Markdown یک زبان نشانه‌گذاری سبک است که می‌توانید برای افزودن عناصر قالب‌بندی به اسناد متن ساده استفاده کنید. ساخته‌شده توسط John Gruber در ۲۰۰۴، Markdown اکنون یکی از محبوب‌ترین زبان‌های نشانه‌گذاری جهان است.

استفاده از Markdown با ویرایشگر WYSIWYG فرق دارد. در اپلیکیشنی مثل Microsoft Word دکمه می‌زنید تا کلمات و عبارات را قالب‌بندی کنید و تغییرات فوراً دیده می‌شود. Markdown این‌طور نیست. وقتی فایل قالب‌بندی‌شده Markdown می‌سازید، نحو Markdown را به متن اضافه می‌کنید تا مشخص کنید کدام کلمات و عبارات باید متفاوت به‌نظر برسند.

عناوین

برای ساخت عنوان، قبل از کلمه یا عبارت علامت شماره (#) بگذارید. تعداد # باید با سطح عنوان مطابقت داشته باشد. مثلاً برای سطح سه: ### عنوان من.

Markdown
HTML
خروجی رندر شده
# Heading level 1
<h1>Heading level 1</h1>

Heading level 1

## Heading level 2
<h2>Heading level 2</h2>

Heading level 2

### Heading level 3
<h3>Heading level 3</h3>

Heading level 3

#### Heading level 4
<h4>Heading level 4</h4>

Heading level 4

##### Heading level 5
<h5>Heading level 5</h5>
Heading level 5
###### Heading level 6
<h6>Heading level 6</h6>
Heading level 6

پاراگراف‌ها

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

Markdown
HTML
خروجی رندر شده
I really like using Markdown.

It lets me write easily.
<p>I really like using Markdown.</p>
<p>It lets me write easily.</p>

I really like using Markdown.

It lets me write easily.

شکست خط

برای شکست خط یا خط جدید، خط را با دو یا چند فاصله تمام کنید و Enter بزنید.

Markdown
HTML
خروجی رندر شده
This is the first line.
And this is the second line.
<p>This is the first line.<br>
And this is the second line.</p>

This is the first line.
And this is the second line.

تأکید

می‌توانید با پررنگ یا مورب کردن متن تأکید اضافه کنید.

پررنگ

برای پررنگ، دو ستاره (**) یا زیرخط (__) قبل و بعد از کلمه یا عبارت بگذارید.

Markdown
HTML
خروجی رندر شده
I just love **bold text**.
I just love <strong>bold text</strong>.

I just love bold text.

I just love __bold text__.
I just love <strong>bold text</strong>.

I just love bold text.

مورب

برای مورب، یک ستاره (*) یا زیرخط (_) قبل و بعد از کلمه یا عبارت بگذارید.

Markdown
HTML
خروجی رندر شده
The *cat* meows.
The <em>cat</em> meows.

The cat meows.

The _cat_ meows.
The <em>cat</em> meows.

The cat meows.

پررنگ و مورب

برای تأکید هم‌زمان پررنگ و مورب، سه ستاره (***) یا زیرخط (___) قبل و بعد بگذارید.

Markdown
HTML
خروجی رندر شده
This text is ***really important***.
This text is <strong><em>really important</em></strong>.

This text is really important.

This text is ___really important___.
This text is <strong><em>really important</em></strong>.

This text is really important.

بلوک نقل‌قول

برای بلوک نقل‌قول، > قبل از پاراگراف بگذارید.

Markdown
HTML
خروجی رندر شده
> Dorothy followed her through many of the beautiful rooms in her castle.
<blockquote><p>Dorothy followed her through many of the beautiful rooms in her castle.</p></blockquote>

Dorothy followed her through many of the beautiful rooms in her castle.

بلوک نقل‌قول تودرتو

بلوک نقل‌قول را می‌توان تودرتو کرد. >> قبل از پاراگرافی که می‌خواهید تودرتو شود بگذارید.

Markdown
خروجی رندر شده
> Dorothy followed her through many of the beautiful rooms in her castle.
>
>> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

Dorothy followed her through many of the beautiful rooms in her castle.

The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.

لیست‌ها

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

لیست‌های مرتب

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

Markdown
HTML
خروجی رندر شده
1. First item
2. Second item
3. Third item
4. Fourth item
<ol>
  <li>First item</li>
  <li>Second item</li>
  <li>Third item</li>
  <li>Fourth item</li>
</ol>
  1. First item
  2. Second item
  3. Third item
  4. Fourth item

لیست‌های نامرتب

برای لیست نامرتب، خط تیره (-)، ستاره (*) یا بعلاوه (+) قبل از خط‌ها بگذارید.

Markdown
HTML
خروجی رندر شده
- First item
- Second item
- Third item
- Fourth item
<ul>
  <li>First item</li>
  <li>Second item</li>
  <li>Third item</li>
  <li>Fourth item</li>
</ul>
  • First item
  • Second item
  • Third item
  • Fourth item

کد

برای مشخص کردن کلمه یا عبارت به‌عنوان کد، آن را در backtick (`) بگذارید.

Markdown
HTML
خروجی رندر شده
At the command prompt, type `nano`.
At the command prompt, type <code>nano</code>.

At the command prompt, type nano.

بلوک‌های کد

برای بلوک کد، هر خط را حداقل چهار فاصله یا یک تب تورفتگی بدهید، یا سه backtick (```) قبل و بعد از بلوک بگذارید.

Markdown
خروجی رندر شده
```
{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}
```
{
  "firstName": "John",
  "lastName": "Smith",
  "age": 25
}

خطوط افقی

برای خط افقی، سه ستاره (***)، خط تیره (---) یا زیرخط (___) در یک خط تنها استفاده کنید.

Markdown
HTML
خروجی رندر شده
***
<hr>

---
<hr>

___
<hr>

تصاویر

برای تصویر، علامت تعجب (!)، بعد متن جایگزین در براکت و مسیر یا URL تصویر در پرانتز بگذارید. اختیاری عنوان را در گیومه بعد از مسیر یا URL بگذارید.

Markdown
HTML
خروجی رندر شده
![The San Juan Mountains](https://mdg.imgix.net/assets/images/san-juan-mountains.jpg "San Juan Mountains")
<img src="https://mdg.imgix.net/assets/images/san-juan-mountains.jpg" alt="The San Juan Mountains" title="San Juan Mountains">
The San Juan Mountains

فرار کاراکتر

برای نمایش کاراکتر تحت‌اللفظی که در سند Markdown برای قالب‌بندی استفاده می‌شود، backslash (\) قبل از کاراکتر بگذارید.

Markdown
خروجی رندر شده
\* Without the backslash, this would be a bullet in an unordered list.

* Without the backslash, this would be a bullet in an unordered list.

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

می‌توانید از backslash برای فرار این کاراکترها استفاده کنید:

\backslash
`backtick
*asterisk
_underscore
{ }curly braces
[ ]brackets
( )parentheses
#pound sign
+plus sign
-minus sign (hyphen)
.dot
!exclamation mark
|pipe

جداول

برای جدول، سه خط تیره (---) یا بیشتر برای هدر هر ستون و لوله (|) برای جدا کردن ستون‌ها استفاده کنید. اختیاری لوله در دو سر جدول بگذارید.

Markdown
خروجی رندر شده
| Syntax    | Description |
| --------- | ----------- |
| Header    | Title       |
| Paragraph | Text        |
SyntaxDescription
HeaderTitle
ParagraphText

تراز

می‌توانید متن ستون‌ها را چپ، راست یا وسط تراز کنید با گذاشتن دو نقطه (:) چپ، راست یا دو طرف خط تیره در ردیف هدر.

Markdown
خروجی رندر شده
| Align Left | Align Center | Align Right |
| :--- | :---: | ---: |
| This | This | This |
| column | column | column |
| will | will | will |
| align | align | align |
| left | center | right |
تراز چپوسطتراز راست
ThisThisThis
columncolumncolumn
willwillwill
alignalignalign
leftcenterright