Docusaurus: परियोजनाओं के दस्तावेजीकरण के लिए एक उत्कृष्ट उपकरण

सॉफ्टवेयर बनाते समय सबसे महत्वपूर्ण कार्यों में से एक है, दुर्भाग्य से हममें से जो इस काम को विकसित करते हैं, कभी-कभी यह थकाऊ लगता है, लेकिन यह किसी के लिए कोई रहस्य नहीं है कि अच्छा प्रलेखन किसी भी उपकरण की सफलता का बिंदु हो सकता है, क्योंकि या तो इसकी वजह से वह सहायता जो उपयोगकर्ताओं को एप्लिकेशन के सही संचालन या अन्य डेवलपर्स को प्रदान करने के लिए प्रदान की गई जानकारी को समझने के लिए दी जाती है।

काफी अच्छे अनुप्रयोग हैं जो हमें अपनी परियोजनाओं को सरल तरीके से दस्तावेज करने की अनुमति देते हैं, कुछ हम जो चाहते हैं उससे अधिक की पेशकश करते हैं और दूसरों को मरम्मत प्रतिष्ठानों की आवश्यकता होती है, दस्तावेज़ परियोजनाओं के लिए उपकरण यह अनुपालन और उपयोग करने के लिए काफी सरल है और Docusaurus है।

Docusaurus क्या है?

डॉक्यूसॉरस के लिए एक परियोजना है ओपन सोर्स टूल्स वेब डॉक्यूमेंटेशन का निर्माण, कार्यान्वयन और रखरखाव, यह भाषा का उपयोग करने की अनुमति देता है Markdown प्रलेखन को लिखने के लिए जिसे बाद में एक html वेबसाइट के रूप में प्रकाशित किया जाएगा, उसी तरह, टूल हमें रिएक्ट के उपयोग के साथ हमारी प्रलेखन वेबसाइट के डिजाइन को बढ़ाने और अनुकूलित करने की अनुमति देता है।

सामान्यतया, फेसबुक प्रोग्रामिंग टीम द्वारा विकसित यह ओपन सोर्स टूल हमें आसानी से सुंदर और हल्की वेबसाइट बनाने की अनुमति देता है जहां हम किसी भी प्रोजेक्ट के दस्तावेज को ठीक से प्रदर्शित कर सकते हैं।

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

Docusaurus का आसान उपयोग इसके डेवलपर्स द्वारा वितरित निम्नलिखित gif में देखा जा सकता है

Docusaurus कैसे स्थापित करें?

Gocusub पर होस्ट किए गए ओपन सोर्स एप्लिकेशन को डॉक्यूमेंट करने के लिए Docusaurus का मुख्य उद्देश्य निश्चित उपकरण होना है, इसलिए इस प्लेटफॉर्म पर अपनी प्रलेखन वेबसाइट को स्थापित करना और चलाना वास्तव में आसान है।

Github पर Docusaurus का आनंद लेना शुरू करने के लिए, विकास टीम द्वारा बताए गए चरणों का पालन करें और जिसे हम नीचे उद्धृत करते हैं:

1. अपने GitHub रिपॉजिटरी डायरेक्टरी के मूल पर जाएं जहां आप दस्तावेज़ बनाएंगे और निम्नलिखित कमांड चलाएंगे:
2. yarn global add docusaurus-init or npm install --global docusaurus-init
3. docusaurus-init

अंतिम परिणाम एक फ़ाइल और निर्देशिका संरचना का निर्माण होगा जैसा कि नीचे दिखाया गया है: