संपादन गाइड

परिवर्तित मार्कडाउन की सफ़ाई कैसे करें

परिवर्तित मार्कडाउन एक ड्राफ़्ट है जो किसी अन्य प्रारूप के संरचनात्मक संकेतों से जोड़ा गया है। चरणों में काम करें: निष्कर्षण शोर हटाएँ, रूपरेखा ठीक करें, ब्लॉक सिंटैक्स सामान्य करें, संदर्भ सत्यापित करें, और उसके बाद ही गद्य को निखारें।

10 मिनट का पठन

संपादन से पहले कच्चे रूपांतरण को सुरक्षित रखें

परिवर्तित परिणाम को अपना स्वयं का दस्तावेज़ रखें और समीक्षा पूरी होने तक स्रोत फ़ाइल बनाए रखें। इससे आपको संदर्भ मिलता है जब टेक्स्ट गायब या गलत क्रम में दिखता है और यह रोकता है कि एक असंबंधित असहेजा ड्राफ़्ट ओवरराइट न हो।

स्वचालित सफ़ाई क्रियाओं के बाद undo का उपयोग करें और एक समय में परिवर्तन की एक ही श्रेणी करें। एक व्यापक पुनर्लेखन कोड के अंदर जानबूझकर रिक्ति या सही सूची नेस्टिंग को गलती से हटा सकता है।

निष्कर्षण शोर हटाएँ

PDF हेडर, पृष्ठ संख्याएँ, दोहराए गए फ़ुटर, स्लाइड लेबल, खाली टेबल पंक्तियाँ और दोहराई गई खाली पंक्तियाँ अक्सर कोई अर्थ नहीं जोड़ती हैं। दोहराए गए अंशों की खोज करें और उन्हें लगातार हटाएँ, ध्यान रखते हुए कि कोई ऐसा वाक्यांश न हटे जो वास्तविक सामग्री का भी हिस्सा है।

  • कोड ब्लॉकों के बाहर तीन या अधिक खाली पंक्तियों के समूह को मिलाएँ।
  • केवल PDF पंक्ति-अंत हाइफ़नेशन से विभाजित शब्दों को जोड़ें।
  • हर पेज पर दोहराया गया नेविगेशन या कानूनी बॉयलरप्लेट हटाएँ।
  • खाली शीर्षक और खाली सूची आइटम हटाएँ।

तार्किक शीर्षक रूपरेखा फिर से बनाएँ

दस्तावेज़ शीर्षक के लिए एक H1 उपयोग करें। मुख्य अनुभाग आमतौर पर H2, उप-अनुभाग H3 इत्यादि उपयोग करते हैं। केवल छोटी दृश्य शैली पाने के लिए स्तर न छोड़ें; प्रस्तुति रेंडरर की है।

परिवर्तित PDF बोल्ड पंक्तियों को शीर्षक के रूप में बहुत आक्रामक रूप से चिह्नित कर सकती हैं, जबकि मैन्युअल फ़ॉर्मेटिंग वाले Word दस्तावेज़ उन्हें बिल्कुल भी चिह्नित नहीं कर सकते। रूपरेखा को सामग्री की तालिका के रूप में पढ़ें और अर्थ के आधार पर स्तर समायोजित करें।

पहले और बाद मेंMarkdown
Before:
# Deployment
#### Prerequisites
## Linux

After:
# Deployment
## Prerequisites
### Linux

सूचियाँ और रिक्ति सामान्य करें

अक्रमित आइटम के लिए एक मार्कर शैली और नेस्टिंग के लिए सुसंगत इंडेंटेशन उपयोग करें। सूची से पहले और बाद में एक खाली पंक्ति रखें, लेकिन हर छोटे आइटम के बीच खाली पंक्तियाँ तब तक न रखें जब तक प्रत्येक आइटम में कई पैराग्राफ न हों।

एक कनवर्टर क्रमांकित शीर्षकों या टेबल कोशिकाओं को सूची आइटम समझ सकता है। पुष्टि करें कि क्रमित संख्या स्रोत पेज लेबल को दर्शाने के बजाय अर्थ रखती है।

संकीर्ण स्क्रीन और स्रोत पठनीयता के लिए टेबल सरल करें

जाँचें कि हर पंक्ति में कोशिकाओं की समान संख्या है और सामग्री के अंदर पाइप वर्ण escape हैं। लंबे शीर्षक छोटे करें, लंबी व्याख्याएँ टेबल के नीचे ले जाएँ, और असंबंधित कॉलम समूहों को विभाजित करें।

विलय कोशिकाओं, नेस्टेड टेबल, चार्ट और स्प्रेडशीट सूत्रों का कोई विश्वसनीय मार्कडाउन-टेबल समकक्ष नहीं है। उन्हें एक सूची, कई छोटी टेबल, एक टेक्स्ट सारांश या बनाए रखी गई स्रोत डेटा के लिंक से बदलें।

लिंक, इमेज और कोड सत्यापित करें

HTML या EPUB से विरासत में मिले सापेक्ष लिंक अपने मूल स्थान पर निर्भर करते हैं। PDF निष्कर्षण URL विभाजित कर सकता है, और Office दस्तावेज़ों में प्रदर्शन टेक्स्ट हो सकता है जिसका लक्ष्य बदल गया है। हर महत्वपूर्ण लिंक को अंतिम गंतव्य में खोलें।

बनाए रखी गई इमेज में वर्णनात्मक वैकल्पिक टेक्स्ट जोड़ें। पुष्टि करें कि फ़ेंस्ड कोड की सही भाषा है और विशेष वर्ण टाइपोग्राफ़िक रूप से परिवर्तित नहीं हुए हैं। अविश्वसनीय सामग्री के रूप में समीक्षा किए बिना कॉपी किए गए कमांड कभी न चलाएँ।

उपस्थिति के बजाय अर्थ के साथ समाप्त करें

नाम, दिनांक, मात्राएँ, कोड और निर्णयों की तुलना स्रोत से करें। उन वाक्यों को फिर से लिखें जो पेज स्थिति, स्लाइड दृश्यों या स्प्रेडशीट रंग पर निर्भर थे। फिर डेस्कटॉप और संकीर्ण चौड़ाई पर पूर्वावलोकन करें, .md फ़ाइल डाउनलोड करें और प्रकाशन प्रणाली में सत्यापित करें।

एक स्वच्छ रूपांतरण को स्वाभाविक रूप से ऐसे दस्तावेज़ की तरह पढ़ा जाना चाहिए जो मार्कडाउन में लिखा गया था—भले ही मूल आधिकारिक रिकॉर्ड बना रहे।

अगले रूपांतरण को एक ही वर्कस्पेस में साफ़ करें

एक परिवर्तित ड्राफ़्ट खोलें, स्रोत और पूर्वावलोकन की तुलना करें, फिर समीक्षित मार्कडाउन कॉपी या डाउनलोड करें।

एक समर्थित फ़ाइल परिवर्तित करें