Markdown کا پیش نظارہ دیکھیں
نجی — آپ کی فائل کبھی محفوظ نہیں کی جاتی
383 حروف · 20 لائنیں
یہ کیسے کام کرتا ہے
لکھیں یا پیسٹ کریں
یا کوئی .md فائل ڈراپ کریں۔ پیش نظارہ ٹائپ کرتے ہی اپ ڈیٹ ہوتا ہے۔
ویسا دیکھیں جیسا یہ نظر آئے گا
ٹیبلز، task lists، strikethrough، footnotes اور رنگین fenced code — GitHub طرز، سادہ CommonMark نہیں۔
اسے ساتھ لے جائیں
HTML کاپی کریں، یا ایک مکمل الگ صفحہ محفوظ کریں جو کہیں بھی کھلے اور ٹھیک سے پرنٹ ہو۔
کون سا Markdown، اور HTML کو sanitise کیوں کیا جاتا ہے
Markdown ایک اسپیسیفکیشن نہیں بلکہ ایک خاندان ہے، اور یہاں وسیع طور پر مانا جانے والا GitHub طرز کا سیٹ استعمال ہوتا ہے: headings، emphasis، فہرستیں، لنکس، تصاویر، block quotes، ٹیبلز، syntax highlighting کے ساتھ fenced code blocks، task lists، strikethrough، footnotes اور خودکار لنکس۔ تقریباً ہر کوئی یہی لکھتا ہے اور README میں یہی ہوتا ہے۔ زیادہ غیر معمولی dialects اور وہ custom plugins جو کوئی خاص سائٹ شامل کرتی ہے — admonition blocks، shortcodes، templating — سپورٹ نہیں ہوتے، اس لیے کسی ایک مخصوص generator کے لیے لکھی دستاویز کا کچھ syntax جوں کا توں لفظی طور پر نظر آ سکتا ہے۔
raw HTML دکھایا جاتا ہے مگر پہلے sanitise کیا جاتا ہے، اور یہی حصہ سمجھنے کے قابل ہے۔ Markdown جان بوجھ کر اپنے اندر HTML کی اجازت دیتا ہے، یعنی کہیں سے بھی آئی Markdown فائل میں script tag، inline event handler، iframe یا javascript: لنک ہو سکتا ہے۔ اسے جوں کا توں دکھانے کا مطلب ہوتا کسی اجنبی کا کوڈ آپ کے سیشن میں چلانا، صرف اس لیے کہ آپ نے اس کا README دیکھنے کے لیے پیسٹ کیا۔ کچھ بھی دکھانے سے پہلے ہر چلنے والی چیز ہٹا دی جاتی ہے، اس لیے فارمیٹنگ بچ جاتی ہے اور کوڈ نہیں۔
یہ اس صفحے کی کوئی تفصیل نہیں بلکہ ایک عمومی سبق ہے۔ ہر وہ سسٹم جو صارفین کا دیا ہوا Markdown دکھاتا ہے — کمنٹ باکس، وکی، سپورٹ ٹکٹ — جب تک sanitise نہ کرے، صارفین کا دیا ہوا HTML دکھا رہا ہوتا ہے، اور “یہ تو صرف Markdown ہے” ہی وہ سوچ ہے جس سے یہ نظر انداز ہو جاتا ہے۔ Markdown کو تبدیل کرنا کوئی سیکیورٹی حد نہیں؛ sanitise کرنے کا مرحلہ ہے۔
آپ کو مواد کا پیش نظارہ ملتا ہے، کسی خاص سائٹ کا نہیں۔ GitHub، GitLab اور کوئی documentation generator ہر ایک اپنی اسٹائل شیٹ، heading anchors اور extensions لگاتا ہے، اس لیے ایک ہی فائل ہر جگہ مختلف دکھتی ہے — یہاں دکھایا گیا ڈھانچہ وہ ہے جس پر سب متفق ہیں۔ کچھ بھی fetch نہیں کیا جاتا، اس لیے ویب ایڈریس سے حوالہ دی گئی تصاویر تبھی لوڈ ہوتی ہیں جب وہ سرور اجازت دے، اور repository کی فائلوں کے relative paths بالکل resolve نہیں ہو سکتے۔
جب آپ کو کچھ اور چاہیے
جو README آپ واقعی لکھ رہے ہیں، اس کا پیش نظارہ وہیں دیکھیں جہاں وہ رہے گا۔ GitHub کا اپنا ایڈیٹر اپنی بالکل درست rendering، extensions اور anchors کے ساتھ پیش نظارہ دکھاتا ہے، اور GitHub CLI — gh markdown-preview — اسی renderer کے ساتھ یہ کام لوکل طور پر کرتا ہے۔ documentation کے لیے، generator خود (MkDocs، Docusaurus، Hugo) live-reload ہونے والا پیش نظارہ رکھتا ہے جو اصل اسٹائلنگ اور navigation دکھاتا ہے، یعنی وہی جو پڑھنے والا دیکھے گا۔
جانچنے کے بجائے ایڈٹ کرنے کے لیے، live پین والا Markdown ایڈیٹر — Obsidian، Typora، VS Code اپنے built-in پیش نظارہ کے ساتھ — ہر بار صفحے میں پیسٹ کرنے سے بہتر ہے، کیونکہ پیش نظارہ ٹائپ کرتے ہی اپ ڈیٹ ہوتا ہے اور فائل اپنی جگہ رہتی ہے۔ یہ صفحہ کسی اور کا Markdown پڑھنے، یا آپ کو بھیجی گئی کسی چیز پر جلدی سے نظر ڈالنے کے لیے ہے۔
اکثر پوچھے جانے والے سوالات
کیا میری دستاویز کہیں محفوظ کی جاتی ہے؟
نہیں۔ کچھ بھی محفوظ نہیں کیا جاتا، کچھ بھی رکھا نہیں جاتا، اور صفحہ لوڈ ہونے کے بعد یہ Wi-Fi بند ہونے پر بھی کام کرتا ہے۔ نوٹس، ڈرافٹس اور اندرونی documentation بالکل وہ چیزیں ہیں جو لوگ بغیر سوچے پیش نظارہ میں پیسٹ کر دیتے ہیں۔
یہ Markdown کا کون سا طرز ہے؟
GitHub طرز، کیونکہ آج کل عملی طور پر "Markdown" کا مطلب یہی ہے۔ ٹیبلز، task lists، strikethrough، خودکار لنکس، footnotes اور syntax رنگوں والے fenced code blocks سب کام کرتے ہیں۔ سادہ CommonMark پیش نظاروں میں ان میں سے کچھ نہیں ہوتا، اسی لیے جو README GitHub پر ٹھیک دکھتا ہے وہ ان میں ٹوٹا ہوا نظر آتا ہے۔
کیا میں اس میں raw HTML استعمال کر سکتا ہوں؟
ہاں، اور دکھانے سے پہلے اسے sanitise کیا جاتا ہے۔ Markdown raw HTML کی اجازت دیتا ہے، اور یہ پیش نظارہ اسے دکھاتا ہے — لیکن جو چیز بھی اسکرپٹ چلا سکے وہ پہلے ہٹا دی جاتی ہے، کیونکہ کسی اور کا README پیسٹ کرنے سے کبھی اس کا کوڈ نہیں چلنا چاہیے۔ فارمیٹنگ، لنکس اور تصاویر سب برقرار رہتے ہیں۔
کیا یہ code blocks کو highlight کرتا ہے؟
ہاں، زبان کی پہچان کے ساتھ، ان زبانوں کے لیے جن کی README میں توقع ہوتی ہے — وہی highlighter جو GitHub طرز کے renderers استعمال کرتے ہیں۔ کھلنے والی fence کے بعد زبان لکھیں اور اسی کے مطابق رنگ لگ جائیں گے۔
کیا میں اسے PDF میں بدل سکتا ہوں؟
ہمارا [Markdown سے PDF](markdown-to-pdf) ٹول بالکل یہی کرتا ہے، مناسب page breaks اور typography کے ساتھ۔ یہ صفحہ پڑھنے اور جانچنے کے لیے ہے؛ وہ ٹول دستاویز تیار کرنے کے لیے۔
میرے Markdown میں موجود تصاویر کا کیا ہو گا؟
ویب ایڈریس سے حوالہ دی گئی تصاویر معمول کے مطابق لوڈ ہوتی ہیں۔ relative path سے حوالہ دی گئی تصاویر — "" — نہیں پڑھی جا سکتیں، کیونکہ ویب پیج کو اس فولڈر تک رسائی نہیں ہوتی جس میں آپ کی فائل رکھی ہے۔ وہ ٹوٹے آئیکن کے بجائے ایک placeholder کے طور پر دکھائی دیتی ہیں جس پر غائب فائل کا نام لکھا ہوتا ہے۔
جاننا مفید ہے: آپ کے Markdown میں موجود raw HTML دکھایا جاتا ہے، مگر پہلے sanitise کیا جاتا ہے — scripts، event handlers اور ہر وہ چیز جو چل سکے، ہٹا دی جاتی ہے، اس لیے کسی اور کا README پیسٹ کرنے سے اس کا کوڈ نہیں چل سکتا۔ GitHub طرز کا Markdown سپورٹ ہوتا ہے؛ زیادہ غیر معمولی dialects اور custom plugins نہیں۔
یہ ٹول اپنی ویب سائٹ پر لگائیں
کسی بھی بلاگ، کلاس پیج یا ہیلپ آرٹیکل کے لیے مفت۔ ایک اسنیپٹ پیسٹ کریں اور آپ کے وزیٹرز اسے سیدھا آپ کے صفحے پر استعمال کر سکیں گے۔