مستندسازی

چیت‌شیت Markdown

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

NOVIN SKILLS / DIGITAL STUDIO

تیترها و بخش‌بندی

سطح تیترها را براساس سلسله‌مراتب معنایی انتخاب کنید.

1# عنوان سند23## بخش اصلی45### زیربخش

تأکید و متن خط‌خورده

خط‌خوردگی در بسیاری از rendererها افزونهٔ GFM است.

1**پررنگ**2*مورب*3~~خط‌خورده~~

نقل‌قول و خط افقی

برای نقل‌قول چندخطی هر خط را با علامت نقل‌قول آغاز کنید.

1> نقل‌قول2> ادامهٔ نقل‌قول34---

پیوند معمولی و reference

reference link آدرس تکراری را از متن اصلی جدا می‌کند.

1[مستندات رسمی](https://example.com)23[راهنما][guide]45[guide]: https://example.com/docs "راهنما"

تصویر با متن جایگزین

متن جایگزین محتوای تصویر را بیان کند؛ از عبارت‌های بی‌اطلاعات پرهیز کنید.

1![نمودار فروش بر اساس ماه](./sales-chart.png)

فهرست تو‌در‌تو

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

1- مورد اصلی2  - زیرمورد3  - زیرمورد دوم41. مرحلهٔ اول52. مرحلهٔ دوم

کد inline و fenced

برچسب زبان syntax highlighting را در renderer پشتیبان فعال می‌کند.

1از `npm run build` برای ساخت استفاده کنید.23```js4const greeting = "Hello";5console.log(greeting);6```

جدول GFM

جدول در CommonMark پایه نیست؛ پشتیبانی مقصد را بررسی کنید.

1| زبان | نوع |2| --- | --- |3| SQL | Query |4| Markdown | Markup |

Task list در GFM

checkboxهای Markdown در همهٔ rendererها فعال نیستند.

1- [x] بررسی محتوا2- [ ] اجرای آزمون3- [ ] بازبینی خروجی

برای استفاده در پروژه

نکات کلیدی

۱
تیترها: # عنوان تا ###### عنوان؛ سطح‌ها را به‌ترتیب استفاده کنید.
۲
متن پررنگ: **متن** و متن مورب: *متن*.
۳
پیوند: [عنوان](https://example.com)؛ مقصد را پیش از انتشار بررسی کنید.
۴
تصویر: ![توضیح جایگزین](image.png).
۵
فهرست نشانه‌دار با - و فهرست شماره‌دار با 1..
۶
نقل‌قول: > متن نقل‌شده و خط جداکننده: ---.
۷
کد درون‌خطی را با backtick و بلوک کد را با سه backtick مشخص کنید.
۸
برای بلوک کد، نام زبان را بعد از سه backtick بیاورید.
۹
جدول را با | و ردیف جداکننده مثل | --- | --- | بسازید.
۱۰
پیش‌نمایش Markdown را بررسی کنید؛ پشتیبانی قابلیت‌ها در ابزارها یکسان نیست.
۱۱
برای شکست خط و جدول، پشتیبانی renderer مقصد را بررسی کنید؛ جدول در CommonMark پایه تعریف نشده و افزونهٔ رایج است.
۱۲
برای کد چندخطی از fenced code block و برچسب زبان استفاده کنید و خروجی را در renderer واقعی پیش‌نمایش بگیرید.