एक महान `README.md` एक सफल ओपन-सोर्स प्रोजेक्ट और एक छोड़े गए प्रोजेक्ट के बीच का अंतर है। और एपीआई दस्तावेज़, फीचर तुलना या कॉन्फ़िगरेशन विकल्प प्रस्तुत करने का सबसे अच्छा तरीका तालिकाओं का उपयोग करना है।
दुर्भाग्य से, मानक मार्कडाउन तालिकाओं को आसान नहीं बनाता है।
मार्कडाउन टेबल संघर्ष
मार्कडाउन टेबल को हाथ से लिखना इस तरह दिखता है:
```मार्कडाउन | संपत्ति | प्रकार | विवरण | |---|---|---| | आईडी | स्ट्रिंग | अद्वितीय पहचानकर्ता | | समयबाह्य | संख्या | समय मिलीसेकेंड में | ```
यदि आप एक पंक्ति में एक लंबा विवरण जोड़ते हैं, तो पूरी तालिका आपके कोड संपादक में दृष्टिगत रूप से गलत संरेखित हो जाती है, जिससे इसे बनाए रखना और पढ़ना अविश्वसनीय रूप से कठिन हो जाता है।
दृश्य निर्माण
सबसे कुशल वर्कफ़्लो विज़ुअल ग्रिड का उपयोग करना है। हमारे [मार्कडाउन टेबल जेनरेटर](/en/markdown-table-generator) के साथ, आप अपनी सामग्री को स्प्रेडशीट-जैसे इंटरफ़ेस में टाइप कर सकते हैं।
आप कॉलम जोड़ सकते हैं, पंक्तियाँ हटा सकते हैं और स्वाभाविक रूप से टाइप कर सकते हैं। एक बार जब आप काम पूरा कर लेते हैं, तो टूल तुरंत पूरी तरह से दूरी पर, साफ-सुथरे स्वरूपित मार्कडाउन सिंटैक्स उत्पन्न करता है। आप बस इसे कॉपी करें और अपने README में पेस्ट करें।
पाइप वर्णों (`|`) और डैश से लड़ना बंद करें, और अपनी तालिकाओं को दृश्य रूप से बनाना शुरू करें!