Markdown: ساختار ، نحو و کنوانسیون ها را بیاموزید

محتوای وب باید در قالب HTML ارائه شود. بسیاری از ابزارهای انتشار وب (مانند نرم افزار وبلاگ نویسی و CMS) محتوای شما (متن ، تصاویر و غیره) را به HTML برای شما تبدیل می کنند. اما شرایط بسیاری وجود دارد که می خواهید خودتان محتوای HTML بنویسید … و علامت گذاری دستی مطالب با برچسب های HTML کار سختی است و واقعاً قابل اجرا نیست. وارد Markdown شوید.

Markdown راهی آسان و بدون اصطکاک برای نوشتن محتوا برای وب و روشی مناسب برای توسعه دهندگان برای ایجاد اسناد است. این امکان را به شما می دهد تا اسناد را با استفاده از نشانه گذاری ساده و مبتنی بر متن ، به راحتی ساختار و قالب بندی کنید ، و سپس برای شما به HTML تبدیل می شود – همه از ویرایشگر متن مورد علاقه شما.

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

بیایید غواصی کنیم!

Markdown چیست؟

علامت گذاری یک زبان نشانه گذاری سبک است که توسط جان گروبر در سال 2004 ایجاد شده است. نوشتن آن آسان است ، قابل خواندن است و به راحتی به HTML تبدیل می شود. در اصل برای نوشتن برای وب طراحی شده است.

این محبوبیت به سرعت رشد کرده و اکنون در زمینه هایی که هرگز توسط سازنده آن پیش بینی نشده است ، مورد استفاده قرار می گیرد. اما کامل نیست این محدودیت دارد ، به ویژه اینکه قالب بندی بسیاری از عناصر HTML را که ممکن است لازم باشد استفاده کنید (مانند جداول) کنار می گذارد. همچنین می تواند کمی مبهم باشد.

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

• مارک مشترک تلاش می کند تا Markdown را استاندارد کرده و آن را مبهم جلوه دهد و این با برخی از نحوهای اصلی در تضاد است.
• GitHub علامت گذاری شده با طعم (GFM) CommonMark را گسترش می دهد و هنگام ایجاد اسناد در GitHub استفاده می شود.
• چند علامت گذاری دستور جدیدی برای جداول ، پاورقی ها ، نقل قول ها و موارد دیگر اضافه کرد.
• پاندوک Markdown را برای چندین قالب خروجی (نه فقط HTML) گسترش می دهد و از فراداده های سند ، پاورقی ها ، جداول ، نسخه های فرعی ، زیرنویس ها و موارد دیگر پشتیبانی می کند.

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

یادگیری Markdown

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

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

شخصاً استفاده می کنم علامت گذاری شده 2 برای پیش نمایش فایلهای Markdown در Mac من. این یک محصول تجاری است ، اما مطمئناً می توانید افزونه های رایگان زیادی را برای ویرایشگر مورد نظر خود پیدا کنید. همچنین می توانید با استفاده از فایلهای Markdown بصورت آنلاین ویرایش و پیش نمایش کنید پیش نمایش مارک داون و StackEdit.

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

اسناد ساختاری

Markdown به شما امکان می دهد عناصر ساختاری مانند موارد دیگر را به سند خود اضافه کنید عناوین (h1، h2، h3 و غیره.). چند روش برای افزودن عناوین در Markdown وجود دارد. مورد علاقه من پیشوند یک عنوان با هش است #، یک برای هر سطح از عنوان:

# Heading 1

## Heading 2

### Heading 3

etc.

And this is body text.

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

### Heading 3 ###

راه دوم نیز وجود دارد ، هرچند که من استفاده از آن را اغلب نمی بینم. با زیر خط زدن عنوان های H1 با برابر می توانید دو سطح عنوان ایجاد کنید = نمادها و عناوین H2 با خط فاصله -:

Heading 1 or Title
==================

Heading 2
---------

بخشهای یک سند را می توان با استفاده از جدا کرد قوانین افقی (<hr />) ، یا خطوط. با استفاده از سه خط (یا بیشتر) این موارد را در Markdown ایجاد می کنید -، ستاره ها *، زیرخط می زند _ یا برابر است = علائم آنها را به تنهایی روی یک خط قرار دهید ، در دو طرف آن خطوط خالی وجود دارد:

Brief introduction.

===

# Chapter 1

Lots of text.

---

# Chapter 2

Some more text

---

لیست ها یکی دیگر از عناصر مهم ساختاری هستند. لیست های نامرتب (<ul>) با شروع خط با ستاره ایجاد می شوند *، به علاوه + نماد ، یا خط -، به دنبال یک فاصله یا برگه ، سپس متن:

* this
* is
* an
* unordered
* list

+ this
+ is
+ too

- and
- so
- is
- this

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

لیست های مرتب شده (<ol>) اعدادی هستند که با دوره ها دنبال می شوند. اعداد لزوماً نباید به ترتیب باشند. هر یک از اینها کار خواهد کرد:

1. this
2. is
3. an
4. ordered
5. list

1. and
1. so
1. is
1. this

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

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

2020. A year we'll never forget.

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

This will be formatted as an HTML paragraph.

And so will this.

قالب بندی متن اصلی

قالب بندی متن اصلی شامل حروف درشت و کج است. Underline تمایل به استفاده در وب ندارد ، زیرا نحوه قالب بندی لینک ها است ، بنابراین توسط Markdown پشتیبانی نمی شود. اگر واقعاً می خواهید از آن استفاده کنید ، فقط استفاده کنید <u> برچسب های HTML (این نکته قابل ذکر است به طور کلی. در جایی که Markdown نوع خاصی از عنصر HTML را پشتیبانی نمی کند ، می توانید به جای آن از نشانه گذاری HTML استفاده کنید. فقط یک نکته وجود دارد: هر نحو Markdown داخل برچسب های HTML تجزیه نمی شوند.)

کلمات با حروف کج با یک ستاره محدود می شوند (*) یا زیر خط (_):

this is *italics*
and so is _this_

کلمات با پررنگ با یک ستاره دوتایی مشخص می شوند (**) یا زیر خط (__):

this is **bold**
and so is __this__

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

برخی دیگر ترجیح می دهند با استفاده از نمادهای مختلف ، ضخیم و مورب را از یکدیگر متمایز کنند: **bold** و _italics_:

_You **can** also combine them_

نقل قول ها و بلوک های کد

نقل قول ها می توان با شروع یک خط با بزرگتر از (>) نماد ، درست مانند مشتریانی که ایمیل قدیمی تر پیام های قبلی را نقل کرده اند:

> This is a blockquote. Single paragraphs
> can be continued like this on a second line.
> 
> Multiple paragraphs can be quoted by using a
> line with a single greater than symbol.

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

> You can also blockquote a paragraph
by placing a single greater than symbol at
the beginning of each paragraph.

> Nested blockquotes are also possible
> > Like this.

بلوک های کد با ایجاد تورفتگی در هر خط حداقل توسط چهار فاصله یا یک زبانه ایجاد می شوند:

This is a normal paragraph:

    This is a code block.

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

``This is a code block.

مارك دون با عطر و طعم GitHub برای شروع و خاتمه بخش كد از سه backtick استفاده می كند. Obsidian ، Bear و برخی دیگر از ویراستاران Markdown از همین قرارداد پیروی می کنند:

```
This is a code block.
```

برای جاسازی آن بلوک کد در یک بلوک کد ، آن را در بک تیک های چهارگانه پیچیدم. در GitHub ، در صورت تمایل می توانید زبان را نیز وارد کنید برجسته سازی نحوی:

```ruby
This is Ruby code with syntax highlighting.
```

کد را می توان با استفاده از جداکننده های بک تیک در یک پاراگراف نمایش داد:

This code `<bold>` will be displayed, not interpreted.

پیوندها و تصاویر

پیوندها و تصاویر از ترکیبی از براکت های مربعی استفاده می کنند [] و پرانتز (). برای پیوندها، متن لنگر را با براکت های مربعی محاصره می کنید ، بلافاصله با URL در پرانتز دنبال می شوید:

This is a [link to a web page](https://url.com).

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

This is a [link to a web page](https://url.com "This title will appear as a tooltip").

روش دیگر برای علامت گذاری لینک ها به عنوان شناخته می شود پیوند مرجع. این موارد در سند Markdown مانند پاورقی ها به نظر می رسند اما هنگام صادر شدن به HTML به پیوندهای استاندارد تبدیل می شوند. در اینجا هدف این است که سند Markdown خواناتر باشد.

به جای لینک مستقیم به URL ، از برچسب در پرانتز مربع استفاده می کنید. سپس در جای دیگر سند (به طور معمول در پایین) ، آن برچسب را با یک URL مرتبط می کنید:

This is a [link to a web page][mylabel].

Then at the end of the document …

[mylabel]: https://url.com "Optional title"
or
[mylabel]: <https://url.com> (Optional title)

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

تصاویر از یک نحو مشابه استفاده کنید اما با علامت تعجب شروع کنید (!):

![Alt text](https://imageurl.com)

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

![Alt text](https://imageurl.com "This is a title")

همچنین می توانید از پیوندهای مرجع برای تصاویر استفاده کنید:

![Alt text][mylabel]

[mylabel]: https://imageurl.com "This is a title"

GitHub Flavored Markdown توسط بسیاری از توسعه دهندگان مورد استفاده قرار می گیرد ، و نحو اضافی را برای توانایی بیشتر آن فراهم می کند. در اینجا چند نمونه آورده شده است.

خط حمله یک گزینه اضافی برای قالب بندی متن است که با tildes دو برابر حاصل می شود (~~):

This is how you do ~~strikethrough~~.

لیست کارها با استفاده از ایجاد می شود - [ ] برای موارد علامت گذاری نشده ، و - [x] برای موارد علامت گذاری شده:

- [ ] This item is unchecked
- [x] This item is checked

شما می توانید ایجاد کنید جدول با استفاده از لوله و خط فاصله برای رسم خطوط. سه یا بیشتر خط فاصله --- هدرها و لوله ها را ایجاد کنید | ایجاد ستون:

| Heading 1 | Heading 2 | Heading 3 |
| --------- | --------- | --------- |
| some text | more here | and this  |
| some more | this too  | and this  |

وقتی ستون ها تراز می شوند ، این بهتر به نظر می رسد ، اما لازم نیست. در هر صورت ، جدول هنگام صادرات به HTML به درستی ایجاد می شود:

| Heading 1 | Heading 2 | Heading 3 |
| --------- | --------- | --------- |
| some text | more here | and this |
| some more | this too | and this |

ایجاد یک جدول مانند این کاملاً خسته کننده است ، به خصوص اگر شما نیاز به ویرایش محتوای سلول ها دارید. خوشبختانه آنلاین وجود دارد ژنراتورهای جدول که روند کار را ساده می کنند.

کلمات نهایی

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

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

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