بخش تاشوی Markdown چیست؟
Markdown برای سادگی قالب سند متن ساده، فایل README و مستند توسعهدهنده شناخته شده است. اما نحو استاندارد Markdown پشتیبانی بومی از ویجت آکاردئون تعاملی یا کلید محتوای تاشو ندارد. برای حل این بدون وابستگی سنگین JavaScript، تجزیهگر مدرن Markdown برچسب HTML5 درونخط را پشتیبانی میکند — بهویژه عنصر افشا <details> و عنصر عنوان <summary>.
با سازنده رایگان آنلاین بخش تاشوی Markdown ما میتوانید مشخصات فنی بلند، خروجی لاگ پرحرف، بخش گسترده پرسش متداول و نمونه کد ثانویه را فوری به ظرف کشویی تمیز و گسترشپذیر بدل کنید. این پویشپذیری سند و تجربه کاربر را بهتر میکند بدون قربانی کردن محتوای پسزمینه ضروری.
شکست نحو details و summary در HTML5
پایه هر کلید آکاردئون Markdown روی دو برچسب استاندارد HTML است:
- برچسب لفاف
<details>: ظرف تعاملی است که هم عنوان کلید قابل دیدن و هم بدنه گسترشپذیر پنهان را نگه میدارد. افزودن ویژگی اختیاریopen(<details open>) باعث میشود ظرف هنگام بار صفحه وب یا README بهطور پیشفرض باز شود. - برچسب عنوان
<summary>: عنوان یا برچسب قابل دیدن را تعریف میکند که کاربر برای عوض کردن دید محتوای زیرین کلیک میکند. سبک سفارشی، قالب متن و Markdown درونخط اغلب داخل یا کنار این عنصر جا میگیرد.
نمونه ساختار نحو استاندارد:
<details>
<summary>برای دیدن دستور راهاندازی مفصل اینجا کلیک کنید</summary>
### پیشنیازها
- Node.js v18+
- npm یا yarn
این فرمان را برای نصب وابستگیها اجرا کنید:
```bash
npm install utiliome-tools
</details>
```[!IMPORTANT] نکته حرفهای برای تجزیهگر Markdown: بیشتر پردازندههای Markdown (مثل GitHub Flavored Markdown) یک خط خالی پس از برچسب بستهشدن
</summary>و پیش از شروع محتوای بدنه میخواهند. بدون این خط خالی، نحو تودرتوی Markdown مثل عنوان (###)، فهرست (-) یا بلوک کد حصاری به جای عنصر HTML تجزیهشده بهصورت متن خام بدون قالب رندر میشود.
کاربردهای رایج محتوای تاشوی گسترشپذیر
۱. تمیز کردن فایل README گیتهاب
مخزنها اغلب دستور راهاندازی مفصل، فهرست متغیر محیط، فهرست تغییر و پارامتر مرجع API میخواهند. گذاشتن همه این اطلاعات مستقیم در یک صفحه اسکرول بیپایان میسازد. پیچیدن لاگ فرمان بلند، پیکربندی محیط و ماتریس وابستگی داخل بلوک تاشوی <details> README را تمیز و در دسترس نگه میدارد.
۲. ساخت صفحه تمیز پرسش متداول
پرسشهای متداول بهطور طبیعی با چیدمان آکاردئون جورند. برچسب HTML تاشو اجازه میدهد کاربر پرسش سطح بالا را سریع ببیند و فقط پاسخ مرتبط با پرسش خودش را باز کند.
۳. پنهان کردن نتیجه آزمون و رد پشته
هنگام انتشار شرح درخواست ادغام یا گزارش مسئله در پلتفرمهایی مثل GitHub، GitLab یا Bitbucket، چسباندن رد پشته عظیم یا خروجی آزمون خودکار میتواند رشته بحث را شلوغ کند. پیچیدن خروجی لاگ در بخش کلید بستهشده جزئیات تشخیصی کامل را برای بازبین حفظ میکند بدون غلبه بر جریان گفتگوی اصلی.
۴. سازماندهی مستند تعاملی و پایگاه دانش
پلتفرمهای مستند مثل Docusaurus، MkDocs، Hugo، Jekyll و GitBook عنصر details در HTML را روان رندر میکنند. میتوانید آموزش چندگامی، حالت لبه پیشرفته و قطعه کد را آسان در پنل تاشو دستهبندی کنید تا بار شناختی خواننده فنی کم شود.
راهنمای سازگاری پلتفرم
| پلتفرم / تجزیهگر | پشتیبانی <details> تاشو |
پشتیبانی Markdown داخل details | یادداشت |
|---|---|---|---|
| GitHub (GFM) | پشتیبانی بومی کامل | کامل پشتیبانی میشود (خط خالی پس از <summary> لازم است) |
ایدهآل برای README.md، شرح PR و نظر مسئله. |
| GitLab | پشتیبانی بومی کامل | کامل پشتیبانی میشود | تجزیه استاندارد details/summary در HTML. |
| Notion | بلوک فهرست کلید بومی | از راه وارد کردن پشتیبانی میشود | تمیز وارد میشود یا بهصورت بلوک کلید چسبانده میشود. |
| Obsidian | پشتیبانی بومی و HTML | کامل پشتیبانی میشود | هم کلید افزونه و هم برچسب HTML استاندارد را پشتیبانی میکند. |
| Azure DevOps | پشتیبانی جزئی | پشتیبانی پایه | برچسب ساده details را در صفحه ویکی پشتیبانی میکند. |
| Jekyll / Hugo | پشتیبانی بومی کامل | نیاز به پیکربندی افزونه Markdown | خروجی HTML معتبر را در بیلد سایت ایستا تضمین میکند. |
بهترین رویههای طراحی آکاردئون Markdown
- عنوان خلاصه روشن و قابل اقدام به کار ببرید: از عنوان مبهم مثل «اطلاعات بیشتر» پرهیز کنید. بهجای آن عنوان صریح مثل «دیدن نتیجه کامل بنچمارک» یا «کلیک برای گسترش قالب متغیر محیط» استفاده کنید.
- نشانه دیداری یا ایموجی بگذارید: افزودن نشانگر پیکان، آیکون پوشه یا ایموجی (مثلاً
▶️،🔍،📋) داخل برچسب summary بازخورد دیداری فوری میدهد که بخش تعاملی است. - ساختار تودرتو را درست تورفته نگه دارید: تورفتگی تمیز برای بلوک تودرتوی HTML یا Markdown را حفظ کنید تا نحو در کامپایلر سخت Markdown نشکند.
برای دام نحو و سقف اندازه در گیتهاب، بخش تاشو در Markdown گیتهاب را ببینید.