डॉक्सिफ़ाइक का उपयोग करके मार्कडाउन फ़ाइलों के साथ प्रलेखन उत्पन्न करें
यदि आप एक मुफ्त प्लगइन, फ्रेमवर्क, या ओपन-सोर्स स्क्रिप्ट बना रहे हैं आपको प्रलेखन की आवश्यकता होगी. यह महत्वपूर्ण है अपने काम का दस्तावेज, अपनी पवित्रता के लिए और अपने भयानक संसाधन को सीखने के लिए दूसरों की मदद करने के लिए.
हालाँकि, ऑनलाइन दस्तावेज़ बनाना एक वास्तविक दर्द हो सकता है। शुक्र है, Docsify यह प्रदान करके आसान बनाता है मुफ्त प्रलेखन जनरेटर मार्कडाउन पर चल रहा है.
ये है एक विशिष्ट स्थिर साइट जनरेटर नहीं है और यह करता है स्थिर HTML / CSS पृष्ठों की आवश्यकता नहीं है. इसके बजाय, यह Markdown फ़ाइलें लोड करता है गतिशील और उन्हें वेब पेज के रूप में प्रदर्शित करता है। काफी साफ़!
Docsify मुखपृष्ठ को देखें लेआउट का पूर्वावलोकन, साथ में आगे सेटअप विवरण.
यह आप की आवश्यकता है index.html फ़ाइल स्वयं बनाएँ, फिर GitHub पेज पर अपलोड किया जा सकता है या अपने स्वयं के सर्वर पर होस्ट किया जा सकता है। वहाँ से, तुम बस प्रत्येक पृष्ठ के लिए मार्कडाउन फाइलें लिखें और अपने प्राथमिक डॉक्स के रूप में उपयोग करें.
पूरी प्रक्रिया में विस्तार से उल्लिखित है त्वरित आरंभ गाइड, इसलिए यह शायद सबसे अच्छी जगह है। यह हो सकता है सभी npm के माध्यम से चलाते हैं, इसलिए यह वास्तव में आपके कमांड प्रॉम्प्ट को जानने में मदद करता है या कम से कम सीखने के लिए तैयार होना चाहिए.
कच्ची HTML फ़ाइल को स्वयं बनाना और Docsify के सेटअप गाइड से टेम्पलेट को कॉपी / पेस्ट करना संभव है। लेकिन, मैं सलाह देता हूं गतिशील रूप से कर रहा है, चूंकि यह समय का एक टन बचाता है और यह वास्तव में बात नहीं है?
जैसे ही आप डॉक्सिफाई सिस्टम सीखते हैं, आप कर सकते हैं Markdown या कच्चे HTML का उपयोग करके सुविधाएँ जोड़ें. इन सुविधाओं में ए शामिल है कस्टम नेविगेशन बार और भी आपका अपना कवर पेज अपने प्रोजेक्ट के लोगो के साथ.
यहां तक कि डॉक्सिफाई भी मुफ्त विषयों का एक गुच्छा के साथ पैक आता है यदि आप पूर्व-तैयार लेआउट के साथ काम करना चाहते हैं। या आप कर सकते हो उनके शोकेस गैलरी के माध्यम से ब्राउज़ करें यह देखने के लिए कि कौन से प्रोजेक्ट अपने दस्तावेज़ के लिए डॉक्सिफ़ाइ का उपयोग करते हैं.
आल थे बुनियादी सेटअप जानकारी और फ़ाइल डाउनलोड GitHub पर पाया जा सकता है, इसलिए यदि आप इसे शॉट देना चाहते हैं तो वहां पर सिर लगाएं.
आप भी कर सकते हैं मुख्य दस्तावेज़ दस्तावेज़ पृष्ठ पर एक लाइव डेमो देखें जो निश्चित रूप से पर्याप्त है, डॉक्सिफाय पर चलता है। इसलिए, यदि आपको वह वेब पेज लेआउट पसंद है, तो आप उसी टेम्पलेट का उपयोग कर सकते हैं और इसे डॉक्सिफाई, 100% मुक्त और ओपन-सोर्स के माध्यम से चला सकते हैं।.
