Markdown संदर्भ पत्रक
Markdown सिंटैक्स की त्वरित संदर्भ मार्गदर्शिका — शीर्षक, सूचियाँ, लिंक, कोड ब्लॉक, तालिकाएँ और अधिक, लाइव रेंडर्ड पूर्वावलोकन के साथ।
कैसे उपयोग करें
- किसी भी सिंटैक्स श्रेणी पर जाने के लिए बाईं ओर विषय सूची का उपयोग करें।
- प्रत्येक कार्ड बाईं ओर कच्चा Markdown सिंटैक्स और दाईं ओर रेंडर परिणाम दिखाता है।
- किसी भी कार्ड पर कॉपी बटन क्लिक करके Markdown स्निपेट क्लिपबोर्ड में कॉपी करें।
- इन स्निपेट को GitHub, Notion, VS Code, Obsidian या किसी भी Markdown संपादक में सीधे उपयोग करें।
अक्सर पूछे जाने वाले प्रश्न
-
Markdown क्या है?
Markdown एक हल्की मार्कअप भाषा है जिसे John Gruber ने 2004 में बनाया था। यह सादे टेक्स्ट प्रतीकों का उपयोग करके स्वरूपित टेक्स्ट लिखने की सुविधा देती है — उदाहरण के लिए, ** से टेक्स्ट घेरने पर वह बोल्ड हो जाता है। Markdown फ़ाइलें GitHub, ब्लॉग प्लेटफॉर्म, दस्तावेज़ीकरण टूल और नोट ऐप्स में रेंडरर्स द्वारा HTML में बदली जाती हैं।
-
क्या Markdown सभी जगह एक समान है?
आधार सिंटैक्स काफी हद तक सुसंगत है, लेकिन विभिन्न प्लेटफ़ॉर्म अलग-अलग एक्सटेंशन का समर्थन करते हैं। GitHub Flavored Markdown (GFM) टास्क सूचियाँ, स्ट्राइकथ्रू और तालिकाएँ जोड़ता है। Obsidian विकिलिंक का समर्थन करता है। कुछ प्लेटफ़ॉर्म CommonMark को मानक के रूप में उपयोग करते हैं। यह संदर्भ पत्रक सबसे व्यापक रूप से समर्थित सुविधाओं पर केंद्रित है।
-
Markdown में लाइन ब्रेक कैसे करें?
सॉफ्ट लाइन ब्रेक बनाने के लिए लाइन के अंत में दो स्पेस जोड़ें और Enter दबाएं। पैराग्राफ ब्रेक के लिए दो लाइनों के बीच एक खाली लाइन छोड़ें। कई रेंडरर्स में, बिना ट्रेलिंग स्पेस के एकल लाइन ब्रेक को स्पेस माना जाता है, ब्रेक नहीं।
-
क्या Markdown के अंदर HTML उपयोग कर सकते हैं?
अधिकांश Markdown रेंडरर्स इनलाइन HTML की अनुमति देते हैं। उदाहरण के लिए, लाइन ब्रेक के लिए <br>, अंडरलाइन के लिए <u>टेक्स्ट</u>, या फोल्डेबल सेक्शन के लिए <details> उपयोग कर सकते हैं। हालांकि, समर्थन अलग-अलग होता है — कुछ सुरक्षा-उन्मुख रेंडरर्स HTML को पूरी तरह हटा देते हैं।
Markdown क्या है?
Markdown एक सादे टेक्स्ट फॉर्मेटिंग सिंटैक्स है जो HTML में बदल जाती है। John Gruber द्वारा 2004 में बनाया गया, इसे ऐसे डिज़ाइन किया गया था जो बिना रेंडर किए भी पठनीय हो — कच्चा टेक्स्ट रेंडरिंग के बिना भी फॉर्मेटेड टेक्स्ट जैसा दिखना चाहिए। आज यह हर जगह उपयोग होता है: GitHub READMEs, तकनीकी दस्तावेज़ीकरण, ब्लॉग प्लेटफॉर्म, Obsidian और Notion जैसे नोट-लेने वाले ऐप्स, और Slack और Discord जैसे चैट टूल।
मूल विचार सरल है: फॉर्मेटिंग इंगित करने के लिए सामान्य अक्षरों का उपयोग करें। एक पंक्ति से पहले # उसे शीर्षक बनाता है। ** से टेक्स्ट घेरने पर वह बोल्ड हो जाता है। चार स्पेस से पंक्ति इंडेंट करने पर वह कोड ब्लॉक बन जाती है।
Markdown संदर्भ पत्रक कैसे मदद करता है
अनुभवी लेखक भी कभी-कभी तालिका संरेखण, नेस्टेड सूची, या सिंटैक्स हाइलाइटिंग के साथ कोड ब्लॉक के सटीक सिंटैक्स को भूल जाते हैं। संदर्भ पत्रक त्वरित खोज के रूप में काम करता है — आप कच्चे सिंटैक्स और रेंडर परिणाम को एक साथ देखते हैं।
यह संदर्भ पत्रक शामिल करता है:
- शीर्षक — h1 से h4 तक चार स्तर
- टेक्स्ट फॉर्मेटिंग — बोल्ड, इटैलिक, स्ट्राइकथ्रू, इनलाइन कोड, हाइपरलिंक
- सूचियाँ — क्रमबद्ध, अक्रमबद्ध, नेस्टेड और टास्क सूचियाँ
- लिंक और चित्र — इनलाइन लिंक, शीर्षक वाले लिंक, चित्र
- ब्लॉककोट्स — एकल और नेस्टेड
- कोड ब्लॉक — सिंटैक्स हाइलाइटिंग के लिए वैकल्पिक भाषा के साथ फेंस्ड
- तालिकाएँ — कॉलम संरेखण विकल्पों के साथ
- क्षैतिज रेखाएँ — दृश्य विभाजकों के रूप में
Markdown के प्रकार
CommonMark एक मानकीकृत विनिर्देश है जो मूल विनिर्देश में अस्पष्टताओं को हल करता है। GitHub, GitLab, Discourse और कई अन्य प्लेटफ़ॉर्म CommonMark या कुछ समान का अनुसरण करते हैं।
GitHub Flavored Markdown (GFM) टास्क सूचियाँ (- [x]), स्ट्राइकथ्रू (~~टेक्स्ट~~), तालिकाएँ और ऑटोलिंक जोड़ता है। अधिकांश कोड प्लेटफ़ॉर्म GFM या उसके सुपरसेट का समर्थन करते हैं।
दैनिक तकनीकी लेखन — READMEs, दस्तावेज़ीकरण, ब्लॉग पोस्ट, नोट्स — के लिए मानक CommonMark और GFM एक्सटेंशन लगभग सभी ज़रूरतों को पूरा करते हैं।
अच्छा Markdown लिखने के सुझाव
सूची मार्करों में सुसंगत रहें। अक्रमबद्ध सूचियों के लिए - या * में से एक चुनें और उसी से काम लें। दोनों मिलाना वैध है लेकिन कच्चे रूप में पढ़ना कठिन होता है।
ब्लॉक तत्वों के बीच खाली लाइनें उपयोग करें। शीर्षकों, कोड ब्लॉकों और ब्लॉककोट्स से पहले और बाद में खाली लाइन अलग-अलग पार्सर में सही रेंडरिंग सुनिश्चित करती है।
इंडेंटेड की बजाय फेंस्ड कोड ब्लॉक को प्राथमिकता दें। ट्रिपल बैकटिक ब्लॉक आपको सिंटैक्स हाइलाइटिंग के लिए भाषा निर्दिष्ट करने की सुविधा देते हैं और स्रोत में दृश्य रूप से स्पष्ट होते हैं।
वर्णनात्मक लिंक टेक्स्ट उपयोग करें। [यहाँ क्लिक करें](url) से [Markdown विनिर्देश](url) पठनीयता और पहुँच दोनों में बेहतर है।