फ़ाइल पढ़ें, फिर तय करें कि क्या बदलना है
README या नोट्स पढ़ने के लिए ऑनलाइन MD व्यूअर चाहिए? .md फ़ाइल खोलें और पढ़ने के लिए प्रीव्यू चुनें। बदलाव करने हों तो एडिटर या स्प्लिट व्यू पर जाएँ; स्रोत देखने और सेव करने के लिए उपलब्ध रहेगा।
बार-बार होने वाले बदलावों के लिए कीबोर्ड शॉर्टकट इस्तेमाल करें, मौजूदा ड्राफ़्ट खोलें और स्थानीय ड्राफ़्ट सेव करना चाहें तो ही चालू करें। ब्राउज़र में सेव ड्राफ़्ट इसी ब्राउज़र प्रोफ़ाइल का है; यह क्लाउड बैकअप नहीं है।
ऐसा एडिटर जो स्रोत सामने रखता है
MD फ़ाइल बिना एडिट किए पढ़ें
शीर्षक, सूचियाँ, तालिकाएँ और कोड पढ़ने के लिए प्रीव्यू को MD व्यूअर की तरह इस्तेमाल करें। पढ़ते समय स्रोत पैनल छिपा रहता है; एडिटर पर लौटने से टेक्स्ट नहीं मिटता।
जटिल हिस्से जोड़ें
शुरुआती तालिका बनाएँ, इनलाइन या अलग पंक्ति में समीकरण जोड़ें, Mermaid उदाहरण डालें या स्थानीय रास्टर इमेज एम्बेड करें। फिर जोड़ा गया स्रोत सीधे एडिट करें।
लिखते समय Markdown का लाइव प्रीव्यू
स्रोत और रेंडर दस्तावेज़ साथ देखने के लिए स्प्लिट चुनें। टाइपिंग रुकने के थोड़ी देर बाद बदलाव दिखते हैं, जिससे तालिका अलाइनमेंट, कोड ब्लॉक और समर्थित फ़ॉर्मूले जाँचना आसान होता है। लंबे दस्तावेज़ का प्रीव्यू हाथ से अपडेट करना पड़ सकता है।
काम करने का तरीका चुनें
एडिटर, प्रीव्यू या स्प्लिट मोड इस्तेमाल करें, फ़ोकस मोड चालू करें, टाइपोग्राफ़ी बदलें और दस्तावेज़ ज़ूम करें। पोर्टेबल कॉपी चाहिए तो Markdown डाउनलोड करें।
उस दस्तावेज़ से शुरुआत करें जिसकी आपको सच में ज़रूरत है
प्रोजेक्ट README
README तुरंत पढ़ने के लिए खोलें, फिर सेटअप निर्देश बदलने हों तो स्प्लिट व्यू लें।
# प्रोजेक्ट का नाम संक्षेप में बताएँ कि **यह प्रोजेक्ट क्या करता है**। ## शुरुआत करें ```bash npm ci ``` ## अगले कदम - [ ] काम करने वाला उदाहरण जोड़ें - [ ] दस्तावेज़ीकरण जाँचें
- पहला पैराग्राफ़ स्पष्ट है
- कमांड कोड फ़ेंस में हैं
- चेकलिस्ट में साफ़ कार्रवाई है
डायग्राम के साथ निर्णय नोट
तर्क और फ़्लोचार्ट को एक ही स्रोत फ़ाइल में रखें।
# समीक्षा वर्कफ़्लो ```mermaid flowchart LR A[ड्राफ़्ट] --> B[समीक्षा] B --> C[प्रकाशित करें] ``` दस्तावेज़ साझा करने से पहले समीक्षक दावों की जाँच करता है।
- डायग्राम सिंटैक्स सही है
- लेबल पढ़ने योग्य हैं
- टेक्स्ट डायग्राम समझाता है
दस्तावेज़ खोलें, प्रीव्यू देखें और सेव करें
फ़ाइल खोलें या उसकी सामग्री पेस्ट करें
.md दस्तावेज़ के लिए फ़ाइल खोलें चुनें या Markdown एडिटर में पेस्ट करें। GitHub README हो तो पहले उसकी रॉ फ़ाइल सेव करें; वेब पता डालने से दस्तावेज़ इंपोर्ट नहीं होता।
पढ़ें या बदलावों की साथ-साथ समीक्षा करें
स्रोत पैनल के बिना पढ़ने के लिए प्रीव्यू चुनें। दस्तावेज़ बदलना हो तो लाइव प्रीव्यू के लिए स्प्लिट इस्तेमाल करें। टूलबार से पूरी सिंटैक्स याद किए बिना शीर्षक, लिंक, सूचियाँ और तालिकाएँ जोड़ सकते हैं।
ऐसी कॉपी सेव करें जिसे फिर एडिट कर सकें
स्रोत डिवाइस पर रखने के लिए MD डाउनलोड चुनें। रेंडर दस्तावेज़ के लिए HTML उपयोगी है; साझा करने की पढ़ने वाली कॉपी के लिए PDF टूल लें। ब्राउज़र ड्राफ़्ट स्टोरेज वैकल्पिक है और सेव की गई फ़ाइल का विकल्प नहीं।
साझा करने से पहले परिणाम जाँचें
| सामग्री | क्या करें | क्या अपेक्षा रखें |
|---|---|---|
| अनजाने में फ़ॉर्मैटिंग | टूलबार से कुछ करने के बाद बनाया गया स्रोत जाँचें। | बोल्ड और सूचियाँ सामान्य Markdown रहती हैं और हाथ से बदली जा सकती हैं। |
| ड्राफ़्ट वापस पाना | सेविंग चालू करें, छोटा बदलाव करें, पेज रीफ़्रेश करें और ड्राफ़्ट वापस लाएँ। | स्टोरेज इसी डिवाइस तक सीमित है और ब्राउज़र सेटिंग इसे मिटा सकती हैं। |
| AI से बना टेक्स्ट | तथ्य जाँचें और अधूरे कोड फ़ेंस या असमर्थित फ़ॉर्मूले ठीक करें। | फ़ॉर्मैटिंग पढ़ने में आसानी देती है; यह जानकारी की सत्यता प्रमाणित नहीं करती। |
इस वर्कफ़्लो के बारे में सवाल
क्या एडिट किए बिना ऑनलाइन MD व्यूअर की तरह इस्तेमाल कर सकते हैं?
हाँ। फ़ाइल खोलें चुनें, .md दस्तावेज़ चुनें और प्रीव्यू पर जाएँ। स्रोत बदले बिना रेंडर की गई सामग्री पढ़ सकते हैं। एडिट करना हो तो एडिटर या स्प्लिट पर लौटें।
लिखते समय MD फ़ाइल ऑनलाइन कैसे प्रीव्यू करें?
स्रोत पेस्ट करें या फ़ाइल खोलें, फिर स्प्लिट चुनें। टाइप करते समय थोड़ी देर बाद प्रीव्यू अपडेट होता है। लंबे दस्तावेज़ के लिए अपने-आप प्रीव्यू रुक जाए तो प्रीव्यू अपडेट करें चुनें। एडिट या देखने के लिए दस्तावेज़ अपलोड नहीं करना पड़ता।
क्या पूरी Markdown सिंटैक्स जाने बिना इस्तेमाल कर सकते हैं?
टूलबार आम सिंटैक्स जोड़ता है और उदाहरण शुरुआत करने में मदद करते हैं। स्रोत सामने रखने से पता चलता है कि बटन क्या बदलते हैं।
ड्राफ़्ट कहाँ सेव होते हैं?
स्थानीय सेविंग चालू हो तो सिर्फ़ इसी ब्राउज़र में। वे डिवाइसों के बीच सिंक नहीं होते और ब्राउज़र स्टोरेज साफ़ करने पर मिट जाते हैं। पक्की कॉपी के लिए MD डाउनलोड करें।
बहुत लंबे दस्तावेज़ का क्या होता है?
एडिटिंग और स्रोत डाउनलोड उपलब्ध रहते हैं। एडिटर को तेज़ रखने के लिए अपने-आप प्रीव्यू रुक सकता है; परिणाम देखना हो तो उसे हाथ से अपडेट करें।
क्या HTML टैग समर्थित हैं?
एडिटर बिना एट्रिब्यूट वाले कुछ फ़ॉर्मैटिंग टैग स्वीकार करता है—रेखांकन, सुपरस्क्रिप्ट, सबस्क्रिप्ट, कीबोर्ड कुंजियाँ और हाइलाइट। बाकी रॉ HTML टेक्स्ट की तरह दिखता है।
क्या फ़ॉर्मूले और डायग्राम इस्तेमाल कर सकते हैं?
एडिटर समर्थित KaTeX फ़ॉर्मूले और Mermaid कोड ब्लॉक रेंडर करता है। गलत सामग्री को चिह्नित किया जाता है ताकि रेंडर एक्सपोर्ट से पहले स्रोत ठीक कर सकें।
यह टूल आपके दस्तावेज़ को कैसे संभालता है
- एडिटर और प्रीव्यू आपके ब्राउज़र में चलते हैं।
- स्थानीय ड्राफ़्ट सेव करना वैकल्पिक है और इसे बंद या साफ़ किया जा सकता है।
- PDF डाउनलोड अलग सर्वर प्रक्रिया है; स्थानीय प्रिंट और MD/HTML डाउनलोड भी उपलब्ध हैं।
फ़ॉर्मैट संदर्भCommonMark सहायताGitHub Flavored Markdown विशिष्टता
दोहराई जा सकने वाली समस्या की रिपोर्ट करेंब्राउज़र, चुनी गई सेटिंग और संवेदनशील जानकारी से मुक्त छोटा उदाहरण बताएँ। निजी दस्तावेज़ ईमेल न करें।