Markdown का प्रीव्यू देखें

कौन-सा Markdown, और HTML सैनिटाइज़ क्यों होता है

Markdown एक स्पेसिफ़िकेशन नहीं, बल्कि एक परिवार है, और यहां जो रूप है वह व्यापक रूप से माना गया GitHub-flavoured सेट है: हेडिंग, ज़ोर (emphasis), लिस्ट, लिंक, इमेज, block quote, टेबल, syntax highlighting वाले fenced code block, task list, strikethrough, footnote और अपने-आप बनने वाले लिंक। लगभग हर कोई यही लिखता है और README में यही होता है। ज़्यादा अनोखी बोलियां और किसी ख़ास साइट के जोड़े कस्टम प्लगइन — admonition block, shortcode, templating — सपोर्टेड नहीं हैं, इसलिए किसी एक ख़ास जनरेटर के लिए लिखे डॉक्यूमेंट की कुछ सिंटैक्स ज्यों की त्यों दिख सकती है।

Raw HTML रेंडर होता है पर पहले सैनिटाइज़ किया जाता है, और यही हिस्सा समझने लायक है। Markdown जान-बूझकर अपने अंदर HTML की इजाज़त देता है, यानी कहीं से भी आई Markdown फ़ाइल में script टैग, inline event handler, iframe या javascript: लिंक हो सकता है। उसे जैसा का तैसा रेंडर करने का मतलब होता कि किसी अनजान का कोड आपके सेशन में सिर्फ़ इसलिए चल जाए क्योंकि आपने देखने के लिए उसका README पेस्ट किया। कुछ भी दिखाने से पहले हर चलने वाली चीज़ हटा दी जाती है, इसलिए फ़ॉर्मैटिंग बचती है और कोड नहीं।

यह इस पेज का कोई ब्योरा नहीं, एक आम सबक़ है। जो भी सिस्टम यूज़र का दिया Markdown रेंडर करता है — कमेंट बॉक्स, विकी, सपोर्ट टिकट — वह असल में यूज़र का दिया HTML रेंडर कर रहा है, जब तक वह सैनिटाइज़ न करे, और “यह तो बस Markdown है” सोचकर ही यह बात नज़रअंदाज़ होती है। Markdown को कन्वर्ट करना सुरक्षा की दीवार नहीं है; सैनिटाइज़ करने वाला स्टेप है।

आपको कंटेंट का प्रीव्यू मिलता है, किसी ख़ास साइट का नहीं। GitHub, GitLab और कोई डॉक्यूमेंटेशन जनरेटर — हर एक अपनी स्टाइलशीट, हेडिंग एंकर और एक्सटेंशन लगाता है, इसलिए एक ही फ़ाइल हर जगह अलग दिखती है — यहां दिखाया गया ढांचा वह है जिस पर सब सहमत हैं। कुछ भी फ़ेच नहीं किया जाता, इसलिए वेब पते से जुड़ी इमेज तभी लोड होती हैं जब वह सर्वर इजाज़त दे, और रिपॉज़िटरी की फ़ाइलों के relative path बिल्कुल resolve नहीं हो सकते।

जब आपको कुछ और चाहिए

जो README आप सच में लिख रहे हैं, उसका प्रीव्यू वहीं देखें जहां वह रहेगा। GitHub का अपना एडिटर ठीक उसी रेंडरिंग, एक्सटेंशन और एंकर के साथ प्रीव्यू दिखाता है, और GitHub CLI — gh markdown-preview — यही काम उसी रेंडरर पर लोकल रूप से करता है। डॉक्यूमेंटेशन के लिए, जनरेटर का अपना live-reload प्रीव्यू (MkDocs, Docusaurus, Hugo) असली स्टाइलिंग और नेविगेशन दिखाता है, जो पाठक देखेगा।

जांचने नहीं बल्कि एडिट करने के लिए, लाइव पैन वाला Markdown एडिटर — Obsidian, Typora, या बिल्ट-इन प्रीव्यू के साथ VS Code — हर बार किसी पेज में पेस्ट करने से बेहतर है, क्योंकि प्रीव्यू टाइप करते-करते अपडेट होता है और फ़ाइल अपनी जगह रहती है। यह पेज किसी और का Markdown पढ़ने के लिए है, या आपको भेजी गई किसी चीज़ पर जल्दी से नज़र डालने के लिए।