برنامه نویسی

راهنمای کامل Markdown – انجمن DEV

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

M↓ چیست؟

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

نحو اصلی Markdown

سرفصل ها

شش سطح سرفصل، از 1 (بزرگترین) تا 6 (کوچکترین) وجود دارد. با استفاده از هش هدر ایجاد کنید # نماد، به دنبال آن یک فاصله و متن شما. تعداد هش ها سطح هدر را تعیین می کند.

# First level heading
## Second level heading
وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

این یک H2 است

این یک H3 است

این یک H4 است

این یک H5 است

این یک H6 است

تاکید. پررنگ و مورب

با استفاده از ستاره بر متن خود تأکید کنید * یا تاکید می کند _ برای پررنگ یا مورب کردن.

*Italic text* or _Italic text_
**Bold text** or __Bold text__
***Bold and italic text*** or ___Bold and italic text___
وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

  • مورب *Italic text* یا _Italic text_ متن کج
  • پررنگ **Bold text** یا __Bold text__ متن پررنگ
  • پررنگ + مورب *** Bold and italic text*** یا ___ Bold and italic text___ متن پررنگ و ایتالیک

هایلایت و Strikethrough

برای متن == برجسته کردن == از علامت های دو برابر استفاده کنید

==highlight==
وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

از tildes دوتایی استفاده کنید ~ به خط خطی متن

~~strikethrough~~
وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

لیست ها

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

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

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

- Bullet point 1
- Bullet point 2
وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

لیست های شماره گذاری شده

شروع کن با 1. یا با هر شماره ای

1. First item
2. Second item 
وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

لیست وظایف

تایپ کنید - [ ] یا 1. [ ] سپس یک فضا با اضافه کردن یک x در پرانتز می توانید کار را کامل یا ناقص تنظیم کنید.

- [ ] Unordered incomplete task list item
1. [x] Numbered completed task list item
وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

نقشه ما:

  1. [x] M↓ چیست؟
  2. [ ] نحو اصلی Markdown
    1. [x] سرفصل ها
    2. [x] تاکید. پررنگ و مورب
    3. [x] هایلایت و Strikethrough
    4. [x] لیست ها
      • [x] لیست های نامرتب
      • [x] لیست های شماره گذاری شده
      • [x] لیست وظایف
    5. [ ] نقل قول های بلوکی
    6. [ ] لینک ها و تصاویر
    7. [ ] کد و کدبلاک
  3. [ ] نحو پیشرفته Markdown
    1. [ ] جداول
    2. [ ] خطوط افقی
    3. [ ] فرار از شخصیت ها
    4. [ ] پاورقی
    5. [ ] نظرات
    6. [ ] فراداده
  4. [ ] ابزارها و برنامه های مفید
  5. [ ] آماده، تنظیم، مارک داون!

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

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

بعد از آن یک فاصله اضافه کنید > به نقل قول.

> This is the blockquote.
>> Double indented
وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

متفاوت همیشه بهتر نیست اما بهتر همیشه متفاوت است!

– نویسنده ناشناس

لینک ها و تصاویر

پیوندها

از فرمول استفاده کنید [Link text](Link url) برای افزودن لینک ها گوگل را باز کنید

تصاویر

یک علامت تعجب اضافه کنید تا هر دو تصویر وب و محلی ارائه شوند

‌![Description](https://www.example.com/image.jpg)
وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

کد و کدبلاک

کد

کدهای درون خطی را با قرار دادن آن در بکتیک اضافه کنید. مثلا فشار دهید ctrl+B برای پررنگ کردن متن

بلوک های کد

نام زبان را بعد از بک‌تیک‌های سه‌گانه اضافه کنید تا برجسته‌سازی Syntax فعال شود. با همه ویرایشگرها کار نمی کند!

def hello_world():
    print("Hello, World!")
وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

نحو پیشرفته Markdown

جداول

با استفاده از لوله جداول ایجاد کنید | و خط تیره ‌-. ردیف هدر با خط خط تیره و لوله از محتوا جدا می شود. هر ستون در ردیف با جدا شده است |.
می توانید سایر قالب بندی های نشانه گذاری را اعمال کنید.

Header 1 | Header 2
---|---
Row 1 | Row 2
وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

تراز ردیفی

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

خطوط افقی

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

How cool is that?
___
The reverse side of the coin
وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

فرار از شخصیت ها

اگر می خواهید یک کاراکتر قالب بندی را به عنوان متن اضافه کنید، ابتدا یک بک اسلش تایپ کنید \. این یعنی \* می دهد *، \_ می دهد _ و غیره.
فرار با کاراکتر بکتیک کار نمی کند.

پاورقی

! برخی از تجزیه‌کننده‌های Markdown ویژگی‌های اضافی مانند لیست‌های کار، پانوشت‌ها و متن خط‌دار ارائه نمی‌دهند. اسناد تجزیه کننده خود را بررسی کنید تا ببینید کدام ویژگی ها پشتیبانی می شوند.

Some body[^1] once told me…

وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

برای افزودن ویکی پدیا1 مانند پاورقی از پرانتزهای مربعی استفاده کنید که قبل از آن یک کارت وجود دارد. سپس محتوای پاورقی را مانند پیوند مرجع اضافه کنید.

مرتکب شدن

Markdown از نظرات پشتیبانی نمی کند، اما بسیاری از ویرایشگران این کار را انجام می دهند. هر کدام فرمت متفاوتی دارند.

متادیتا یا Frontmatter

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

---
type: book
start-date: 2023-01-01
finish-date: 2023-03-22
---
وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

ابزارها و برنامه های مفید

در اینجا لیستی از ابزارها و برنامه هایی وجود دارد که کار با Markdown را لذت بخش تر می کند:

  • ویرایشگرهای متن: iA Writer ❤️، Sublime Text، Atom، Visual Studio Code، Vim ❤️، Emacs، Notepad++، BBEdit، Ulysses، LightPaper، TextMate، Byword، Brackets.
  • پیش‌نمایش‌های Markdown: Marked 2، Typora، Dillinger، StackEdit، Remarkable، Pandoc، Haroopad، MacDown، Abricotine، ReText.
  • برنامه های یادداشت برداری: Bear، Simplenote، Joplin، Evernote، Quiver، Zettlr، Turtl، Boostnote، Notable، Inkdrop، Standard Notes، Obsidian ❤️.
  • ابزارهای مستندسازی و همکاری: GitHub، GitLab، Bitbucket، HackMD، Notion، Dropbox Paper، Slite، Confluence، BookStack، Docusaurus، MkDocs.

آماده، تنظیم، مارک داون!

اکنون به دانشی برای ایجاد اسناد زیبا و جذاب با استفاده از Markdown مجهز شده‌اید. ادامه دهید، خلاقیت خود را آزاد کنید و اجازه دهید کلماتتان با سبک جریان یابد. نوشتن مبارک!

PS

آیا می خواهید راهنماهای بیشتری از این دست داشته باشید یا می خواهید دانش خود را به اشتراک بگذارید؟ به جامعه دیجیتال سازندگان خوش آمدید، برای جزئیات به https://dev.to/ytskk/lets-create-developers-community-5g1o مراجعه کنید.


  1. به معنی https://en.wikipedia.org/ ↩

نوشته های مشابه

دیدگاهتان را بنویسید

نشانی ایمیل شما منتشر نخواهد شد. بخش‌های موردنیاز علامت‌گذاری شده‌اند *

همچنین ببینید
بستن
دکمه بازگشت به بالا