इस्तेमाल करने का तरीका
- एडिटर में Markdown लिखें या टेबल और टास्क लिस्ट वाला दस्तावेज़ लोड करने के लिए “उदाहरण आज़माएँ” दबाएँ।
- टाइप करते हुए प्रीव्यू को अपडेट होते देखें। जनरेट किया गया मार्कअप देखने के लिए “HTML सोर्स” पर जाएँ।
- टेक्स्ट जहाँ प्रकाशित होगा, उसके अनुसार GitHub Flavored Markdown या एकल लाइन ब्रेक चालू या बंद करें।
- HTML को CMS या ईमेल में कॉपी करें, या नतीजे को .html या .md फ़ाइल के रूप में डाउनलोड करें।
यह कैसे काम करता है
Markdown को marked से बदला जाता है—यह एक व्यापक रूप से इस्तेमाल किया जाने वाला ओपन-सोर्स पार्सर है, जो CommonMark विनिर्देश का पालन करता है। GFM विकल्प चालू होने पर यह GitHub Flavored Markdown का भी पालन करता है: पाइप से बने टेबल जिनमें कॉलम संरेखित किए जा सकते हैं, टास्क लिस्ट, ~~स्ट्राइकथ्रू~~ और बिना फ़ॉर्मैट वाले URL के लिए अपने-आप लिंक। फ़ुटनोट, गणितीय सूत्र और Mermaid डायग्राम इन विनिर्देशों का हिस्सा नहीं हैं और सादे टेक्स्ट के रूप में दिखते हैं।
Markdown में रॉ HTML हो सकता है, और ज़्यादातर Markdown रेंडरर की तरह, उस HTML को बिना बदले आगे भेजा जाता है। आपकी सुरक्षा के लिए, प्रीव्यू को इस पेज में कभी नहीं डाला जाता। इसे एक सैंडबॉक्स वाले फ़्रेम में दिखाया जाता है, जिसमें स्क्रिप्ट चलाने, फ़ॉर्म सबमिट करने, पॉप-अप खोलने या इस साइट तक पहुँचने की अनुमति नहीं है। इसकी कंटेंट सिक्योरिटी पॉलिसी स्क्रिप्ट, बाहरी स्टाइलशीट, फ़ॉन्ट और फ़्रेम को ब्लॉक करती है। आपके Markdown में मौजूद <script> टैग या onclick एट्रिब्यूट HTML सोर्स में दिखता है, लेकिन कभी चलता नहीं है। प्रीव्यू में लिंक दिखते हैं, पर खुलते नहीं; किसी लिंक पर जाने के लिए उसका URL कॉपी करें।
प्रीव्यू में आम README रेंडरर जैसी न्यूट्रल स्टाइलशीट इस्तेमाल होती है; आपकी वेबसाइट या GitHub उसी HTML को अलग तरह से स्टाइल कर सकते हैं। कॉपी किया गया HTML बिना स्टाइल वाला मूल फ़्रैगमेंट होता है; डाउनलोड की गई .html फ़ाइल में एक बुनियादी स्टाइलशीट जोड़ी जाती है, ताकि वह प्रीव्यू जैसी दिखे। डाउनलोड या कॉपी किए गए HTML को सैनिटाइज़ नहीं किया जाता, इसलिए अगर उसमें स्क्रिप्ट हैं, तो जहाँ भी आप उसे पेस्ट या खोलेंगे, वे चलेंगी।
उदाहरण
पुश करने से पहले README जाँचना
GitHub पर फ़ाइल भेजने से पहले README.md पेस्ट करके जाँचें कि टेबल के कॉलम ठीक से संरेखित हैं, टास्क लिस्ट चेकबॉक्स के रूप में दिखती है और कोड ब्लॉक सही ढंग से फ़ेंस किए गए हैं।
HTML स्वीकार करने वाले CMS के लिए लिखना
Markdown में ब्लॉग पोस्ट का ड्राफ़्ट बनाएँ, फिर “HTML कॉपी करें” दबाएँ और <h2>, <p> और <ul> मार्कअप को CMS के HTML एडिटर में पेस्ट करें।
चैट जैसी लाइन ब्रेक
चैट ऐप के टेक्स्ट में हर लाइन के बीच एक लाइन ब्रेक होता है। “एकल लाइन ब्रेक को <br> मानें” चालू करने से ये लाइनें अलग रहती हैं, बजाय एक ही पैराग्राफ़ में जुड़ने के।
अक्सर पूछे जाने वाले सवाल
क्या किसी अनजान स्रोत से Markdown पेस्ट करना सुरक्षित है?
हाँ, प्रीव्यू देखने के लिए। रेंडर किया गया HTML ऐसे सैंडबॉक्स फ़्रेम में दिखाया जाता है जिसमें स्क्रिप्ट बंद हैं, इसलिए टेक्स्ट में मौजूद <script> टैग या इवेंट हैंडलर भी यहाँ कुछ नहीं करता। एक्सपोर्ट किए गए HTML को कहाँ पेस्ट करते हैं, इस बारे में सावधान रहें, क्योंकि उसे सैनिटाइज़ नहीं किया जाता।
मेरी इमेज क्यों नहीं दिख रही हैं?
डिफ़ॉल्ट रूप से दूसरी वेबसाइटों की इमेज ब्लॉक रहती हैं, ताकि प्रीव्यू कोई नेटवर्क अनुरोध न करे। उन्हें दिखाने के लिए “दूसरी वेबसाइटों से इमेज लोड करें” चालू करें। ./docs/screenshot.png जैसे रिलेटिव पाथ काम नहीं कर सकते, क्योंकि वे फ़ाइलें यहाँ मौजूद नहीं हैं।
क्या यह फ़ुटनोट, गणित या डायग्राम सपोर्ट करता है?
नहीं। यह CommonMark और GitHub Flavored Markdown (टेबल, टास्क लिस्ट, स्ट्राइकथ्रू, ऑटोलिंक) को सपोर्ट करता है। फ़ुटनोट, LaTeX गणित और Mermaid डायग्राम ऐसे एक्सटेंशन हैं जिन्हें यह प्रीव्यू सादे टेक्स्ट के रूप में दिखाता है।
एक लाइन ब्रेक से नई लाइन क्यों शुरू नहीं होती?
मानक Markdown में, पैराग्राफ़ के भीतर एक लाइन ब्रेक को स्पेस माना जाता है। लाइन के अंत में दो स्पेस दें, एक खाली लाइन छोड़ें या “एकल लाइन ब्रेक को <br> मानें” चालू करें।
गोपनीयता
Markdown आपके ब्राउज़र में बदला जाता है; इसे अपलोड या स्टोर नहीं किया जाता। जब तक आप दूसरी वेबसाइटों से इमेज लोड करने की अनुमति नहीं देते, प्रीव्यू इंटरनेट से कुछ भी लोड नहीं करता। अनुमति देने पर इमेज का अनुरोध सीधे उनके होस्ट से किया जाता है।