Markdown کولپسیبل سیکشنز کیا ہیں؟
Markdown سادہ متن دستاویزات، README فائلوں اور ڈویلپر دستاویزات فارمیٹ کرنے کی سادگی کے لیے مشہور ہے۔ تاہم معیاری Markdown نحو انٹرایکٹو accordion ویجٹس یا کولپسیبل مواد ٹوگلز کی نیٹو سپورٹ نہیں رکھتا۔ بھاری JavaScript انحصار کے بغیر حل کے لیے جدید Markdown پارسرز ان لائن HTML5 ٹیگز سپورٹ کرتے ہیں—خاص طور پر <details> disclosure عنصر اور <summary> کیپشن عنصر۔
ہمارا مفت آن لائن Markdown Collapsible Section Generator استعمال کر کے لمبی تکنیکی وضاحتیں، لفظی لاگ آؤٹ پٹس، وسیع FAQ سیکشنز اور ثانوی کوڈ نمونے فوری صاف، پھیلتے ڈراپ ڈاؤن کنٹینرز میں بدل سکتے ہیں۔ یہ دستاویز اسکین ایبلٹی اور صارف تجربہ بہتر کرتا ہے بغیر ضروری پس منظر مواد پر سمجھوتہ کیے۔
HTML5 Details اور Summary نحو کی تفصیل
کسی بھی Markdown accordion ٹوگل کی بنیاد دو معیاری HTML ٹیگز پر ہے:
<details>ریپر ٹیگ: انٹرایکٹو کنٹینر جو نظر آنے والا ٹوگل عنوان اور پوشیدہ پھیلتا جسم مواد دونوں رکھتا ہے۔ اختیاریopenوصف (<details open>) شامل کرنے سے کنٹینر ویب صفحہ یا README لوڈ ہونے پر ڈیفالٹ کھلتا ہے۔<summary>عنوان ٹیگ: نظر آنے والا عنوان یا لیبل طے کرتا ہے جس پر صارفین بنیادی مواد کی مرئیت ٹوگل کرنے کے لیے کلک کرتے ہیں۔ کسٹم اسٹائلنگ، متن فارمیٹنگ اور ان لائن Markdown اکثر اس عنصر کے اندر یا ساتھ شامل ہو سکتا ہے۔
معیاری نحو ڈھانچہ مثال:
<details>
<summary>Click here to view detailed setup instructions</summary>
### Prerequisites
- Node.js v18+
- npm or yarn
Run the following command to install dependencies:
```bash
npm install utiliome-tools
</details>
```[!IMPORTANT] Markdown پارسرز کے لیے پرو ٹپ: زیادہ تر Markdown پروسیسرز (جیسے GitHub Flavored Markdown) بند
</summary>ٹیگ کے بعد جسم مواد شروع ہونے سے پہلے خالی لائن مانگتے ہیں۔ اس خالی لائن کے بغیر نیسٹڈ Markdown نحو جیسے ہیڈرز (###)، فہرستیں (-) یا فینسڈ کوڈ بلاکس (```) خام غیر فارمیٹ شدہ متن کے طور پر رینڈر ہوں گے بجائے پارس شدہ HTML عناصر کے۔
پھیلتے کولپسیبل مواد کے عام استعمال
1. GitHub README فائلیں صاف کرنا
ریپوزٹریز اکثر تفصیلی سیٹ اپ ہدایات، environment variables فہرستیں، چینج لاگز اور API ریفرنس پیرامیٹرز مانگتی ہیں۔ یہ سب ایک صفحے میں رکھنا لامحدود اسکرول دیتا ہے۔ لمبے کمانڈ لاگز، ماحول کنفیگریشنز اور dependency میٹرکس کولپسیبل <details> بلاکس میں لپیٹ کر README صاف اور قابلِ رسائی رہتی ہے۔
2. صاف FAQ صفحات بنانا
اکثر پوچھے گئے سوالات قدرتی طور پر accordion لے آؤٹ میں فٹ ہوتے ہیں۔ کولپسیبل HTML ٹیگز صارفین کو اعلیٰ سطح کے سوالات تیزی سے اسکین کرنے اور صرف متعلقہ جوابات پھیلانے دیتے ہیں۔
3. ٹیسٹ نتائج اور اسٹیک ٹریسز چھپانا
GitHub، GitLab یا Bitbucket پر پل ریکویسٹ وضاحتیں یا ایشو رپورٹس شائع کرتے وقت بڑے اسٹیک ٹریسز یا خودکار ٹیسٹ آؤٹ پٹ بحث تھریڈز گندا کر سکتے ہیں۔ لاگ آؤٹ پٹس بند ٹوگل سیکشن میں لپیٹ کر ریویوئرز کے لیے مکمل تشخیصی تفصیلات محفوظ رہتی ہیں بغیر بنیادی گفتگو بہاؤ دباؤ کے۔
4. انٹرایکٹو دستاویزات اور نالج بیسز منظم کرنا
Docusaurus، MkDocs، Hugo، Jekyll اور GitBook جیسے دستاویزی پلیٹ فارمز HTML details عناصر ہموار رینڈر کرتے ہیں۔ کثیر قدمی ٹیوٹوریلز، جدید ایج کیسز اور کوڈ سنپٹس کولپسیبل پینلز میں آسانی سے درجہ بند کر کے تکنیکی قارئین کا ادراکی بوجھ کم کریں۔
پلیٹ فارم مطابقت گائیڈ
| پلیٹ فارم / پارسر | کولپسیبل <details> سپورٹ |
Details کے اندر Markdown سپورٹ | نوٹس |
|---|---|---|---|
| GitHub (GFM) | مکمل نیٹو سپورٹ | مکمل سپورٹڈ (<summary> کے بعد خالی لائن درکار) |
README.md، PR وضاحتوں اور ایشو کمنٹس کے لیے مثالی۔ |
| GitLab | مکمل نیٹو سپورٹ | مکمل سپورٹڈ | معیاری HTML details/summary پارسنگ۔ |
| Notion | نیٹو ٹوگل لسٹ بلاک | امپورٹ کے ذریعے سپورٹڈ | صاف امپورٹ یا ٹوگل بلاکس کے طور پر پیسٹ۔ |
| Obsidian | نیٹو اور HTML سپورٹ | مکمل سپورٹڈ | پلگ اِن ٹوگلز اور معیاری HTML ٹیگز دونوں سپورٹ۔ |
| Azure DevOps | جزوی سپورٹ | بنیادی سپورٹ | وکی صفحات میں سادہ details ٹیگز سپورٹ۔ |
| Jekyll / Hugo | مکمل نیٹو سپورٹ | Markdown ایکسٹینشن کنفیگریشن درکار | سٹیٹک سائٹ بلڈز پر درست HTML آؤٹ پٹ یقینی۔ |
Markdown Accordions ڈیزائن کرنے کی بہترین مشقیں
- صاف، عمل پذیر خلاصہ عنوانات استعمال کریں: "More Info" جیسے مبہم عنوانات سے بچیں۔ بجائے واضح عنوانات جیسے "View Full Benchmark Results" یا "Click to Expand Environment Variable Template"۔
- بصری اشارے یا ایموجیز شامل کریں: تیر انڈیکیٹرز، فولڈر آئیکنز یا ایموجیز (مثلاً
▶️،🔍،📋) summary ٹیگ میں شامل کر کے فوری بصری فیڈ بیک دیں کہ سیکشن انٹرایکٹو ہے۔ - نیسٹڈ ڈھانچہ درست انڈینٹ رکھیں: نیسٹڈ HTML یا Markdown بلاکس کی صاف انڈینٹیشن برقرار رکھیں تاکہ سخت Markdown کمپائلرز پر نحو نہ ٹوٹے۔
GitHub پر نحو کے نقصانات اور سائز حدوں کے لیے دیکھیں collapsible sections in GitHub Markdown۔