README मार्कडाउन पूर्वावलोकन और ब्राउज़र-प्रथम संपादन
इस गाइड का उपयोग तब करें जब ब्राउज़र-प्रथम मार्कडाउन कार्यक्षेत्र पृष्ठ को छोड़े बिना रीडमी-शैली की सामग्री को ड्राफ्ट, पूर्वावलोकन और साझा करने का सबसे तेज़ तरीका है।
यह वर्तमान कॉमयूटिल मार्कडाउन संपादक से जुड़ा रहता है: लाइव पूर्वावलोकन, स्प्लिट व्यू, प्रीसेट हाइड्रेशन और स्पष्ट शेयर हैंडलिंग। यह रिपॉजिटरी इतिहास या सहयोगी दस्तावेज़ समीक्षा को प्रतिस्थापित नहीं करता है।
इसे तब उपयोग करें जब
आपको लाइव पूर्वावलोकन के साथ एक तेज़ README, रिलीज़-नोट, या रनबुक ड्राफ्ट की आवश्यकता है और कोई अनिवार्य संपादक इंस्टॉल नहीं है।
पहले क्या जाँचें
इससे पहले कि आप मान लें कि मार्कडाउन ही समस्या है, व्यू मोड, पूर्वावलोकन रेंडरिंग और शेयर स्थिति को एक साथ जांचें।
गार्डरेल
प्रतिलिपि को वर्तमान ब्राउज़र-प्रथम संपादक के अनुसार तथ्यात्मक रखें: स्थानीय ड्राफ्ट व्यवहार, पूर्व निर्धारित प्रवाह, और स्पष्ट साझा यूआरएल केवल तभी जब आप उन्हें चुनते हैं।
README आउटलाइन
अंतिम विवरण लिखने से पहले जब आपको शीर्षक संरचना की आवश्यकता हो तो रीडमी प्रीसेट से प्रारंभ करें।
# Project Overview
## Install
## Usage
रिलीज़ नोट्स
जब कार्य का प्रारूप स्पष्ट रूप से बदल रहा हो तो पाठकों को शीघ्रता से स्कैन करने के लिए रिलीज़-नोट ड्राफ्ट का उपयोग करें।
# Release Notes
- Added safer share handling
- Fixed layout regressions
इंसिडेंट रनबुक
जब मार्कडाउन मार्केटिंग कॉपी के बजाय परिचालन मार्गदर्शन बन जाएगा तो रनबुक पैटर्न पर स्विच करें।
## Triage
1. Confirm impact
2. Capture rollback window
3. Share updates
मार्कडाउन संपादक तब सबसे मजबूत होता है जब आपको भारी लेखन स्टैक में जाए बिना तेज़ ड्राफ्ट, लाइव पूर्वावलोकन और नियंत्रित शेयर व्यवहार की आवश्यकता होती है।
- पहले स्प्लिट व्यू का उपयोग करें ताकि स्रोत और प्रस्तुत आउटपुट एक साथ दृश्यमान रहें।
- स्थानीय ड्राफ्ट स्टोरेज और स्पष्ट शेयर यूआरएल को अलग-अलग वर्कफ़्लो के रूप में मानें।
प्रीसेट लिंक व्यापक रूप से साझा करने के लिए सुरक्षित हैं, जबकि स्पष्ट ड्राफ्ट यूआरएल को केवल तभी कॉपी किया जाना चाहिए जब सटीक मार्कडाउन बॉडी को यात्रा करने की आवश्यकता हो।
- यदि यूआरएल के लिए ड्राफ्ट बहुत बड़ा है, तो इसे शेयर स्थिति में डालने के बजाय स्थानीय ब्राउज़र वर्कफ़्लो का उपयोग करना जारी रखें।
- जब समीक्षा का दायरा दो दस्तावेज़ संशोधनों की तुलना कर रहा हो, न कि एक सक्रिय ड्राफ्ट का पूर्वावलोकन कर रहा हो तो अंतर का उपयोग करें।