जीथब + मार्काडाउन = व्यूकोड

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

जब मैंने जीआईएडीबी पर आरईएडीएमई को उकसाया, तो मैंने प्रलेखन के लिए केवल 2 विकल्प पर विचार किया: जीथब पेज और रीड डॉक्स । दुर्भाग्य से, मुझे दोनों के साथ समस्या हो रही है। ज्यादातर डॉक्स मुझे रीस्ट्रक्चर किए गए टेक्स्ट का उपयोग करने के लिए मजबूर करते हैं, और जीथब पेज का अर्थ है एक अलग शाखा का समर्थन करना और एक स्थिर पेज जनरेटर का उपयोग करना।

वास्तव में, मैं Gist.io के समान कुछ करना चाहूंगा , केवल मेरे भंडार के लिए। कुछ भी उपयुक्त नहीं पाकर, मैंने इसे स्वयं लिखा।

मैं इसे Viewdocs कहता हूं । फ्लाई पर सेवा आपके प्रोजेक्ट के डॉक्स फ़ोल्डर में मार्कडाउन से पेज बनाती है। स्थापना की आवश्यकता नहीं है, बस सम्मेलनों का पालन करें। शायद यह पहले से ही आपके लिए काम करता है, क्योंकि डॉक्स फ़ोल्डर में मार्कडाउन असामान्य नहीं है।

डिफ़ॉल्ट टेम्पलेट Gist.io से उधार लिया गया था।

आप Viewdocs पर अधिक जान सकते हैं, जो Viewdocs पर चलता है। या यहाँ एक छोटा सा परिचय है: