Markdown प्रोजेक्ट्स को व्यवस्थित करना

सफलता के लिए अपने डॉक्यूमेंटेशन को संरचित करें

अच्छा संगठन Markdown प्रोजेक्ट्स को बनाए रखने, नेविगेट करने और स्केल करने में आसान बनाता है। चाहे आप किसी सॉफ़्टवेयर प्रोजेक्ट, किताब, या कंटेंट लाइब्रेरी के लिए डॉक्यूमेंटेशन प्रबंधित कर रहे हों, उचित संरचना समय बचाती है और परेशानियों को रोकती है।

यह गाइड Markdown फ़ाइलों और प्रोजेक्ट्स को व्यवस्थित करने के लिए सर्वोत्तम प्रथाओं को कवर करती है।

फ़ाइल नामकरण नियम

वर्णनात्मक नाम उपयोग करें

फ़ाइलों को उनकी सामग्री के आधार पर नाम दें, मनमाने पहचानकर्ताओं के नहीं:

# Good
getting-started.md
api-reference.md
troubleshooting-guide.md

# Avoid
doc1.md
chapter_final_v2_FINAL.md

हाइफ़न के साथ लोअरकेस

सभी सिस्टम में संगतता के लिए लोअरकेस अक्षर और हाइफ़न उपयोग करें:

# Good
user-authentication.md

# Avoid
User_Authentication.md

फ़ोल्डर संरचना

डॉक्यूमेंटेशन प्रोजेक्ट

docs/
├── README.md
├── getting-started/
│   ├── installation.md
│   ├── configuration.md
│   └── quick-start.md
├── guides/
│   ├── user-guide.md
│   └── admin-guide.md
├── reference/
│   ├── api.md
│   └── cli.md
└── assets/
    └── images/

किताब या लंबा कंटेंट

book/
├── README.md
├── 01-introduction/
│   ├── chapter.md
│   └── images/
├── 02-fundamentals/
│   ├── chapter.md
│   └── images/
└── appendix/
    └── glossary.md

सर्वोत्तम प्रथाएं

प्रति फ़ाइल एक विषय

हर फ़ाइल को एक ही विषय पर केंद्रित रखें। जब कंटेंट किसी विशाल दस्तावेज़ में दबा न हो तो इसे ढूंढना, एडिट करना और पुन: उपयोग करना आसान है।

रूट README का उपयोग करें

प्रोजेक्ट रूट पर एक README.md बनाएं जो अवलोकन और अन्य दस्तावेज़ों तक नेविगेशन प्रदान करे।

एसेट्स को अलग रखें

इमेज और अन्य एसेट्स को समर्पित फ़ोल्डर में रखें। उन्हें संदर्भित करने के लिए रिलेटिव पाथ उपयोग करें:

![Diagram](./assets/images/architecture.png)

इंडेक्स फ़ाइलें

बड़े प्रोजेक्ट्स में, हर फ़ोल्डर में इंडेक्स या अवलोकन फ़ाइलें जोड़ें:

guides/
├── README.md  # Overview of all guides
├── user-guide.md
└── admin-guide.md

अपने प्रोजेक्ट को बैच कन्वर्ट करें

वर्शन कंट्रोल टिप्स

.gitignore - जनरेट की गई फ़ाइलें (PDF, HTML) को बाहर रखें अगर आप उन्हें फिर से जनरेट करते हैं
सार्थक कमिट - डॉक्यूमेंटेशन बदलावों के लिए स्पष्ट कमिट मैसेज लिखें
ब्रांचिंग - बड़े डॉक्यूमेंटेशन अपडेट के लिए ब्रांच का उपयोग करें
पुल रिक्वेस्ट - कोड की तरह डॉक्यूमेंटेशन बदलावों की समीक्षा करें

व्यवस्थित प्रोजेक्ट्स को कन्वर्ट करना

एक अच्छी तरह से व्यवस्थित प्रोजेक्ट बैच कन्वर्शन को सरल बनाता है:

अपने docs फ़ोल्डर पर जाएं
वे फ़ाइलें चुनें जिन्हें आपको कन्वर्ट करना है
सबको प्रोसेस करने के लिए बैच कन्वर्शन का उपयोग करें
आपकी संरचना बनाए रखते हुए कन्वर्ट की गई फ़ाइलों वाला ZIP डाउनलोड करें