GitHub के लिए एक असामान्य ऐड-ऑन का एक प्रोटोटाइप, GitHub पेज का उपयोग करके एक वेब-आधारित सहायता प्रणाली

वेब डिजाइनिंग के क्षेत्र में अपने जोखिम भरे और अमानवीय प्रयोगों को जारी रखते हुए, आज मैं आपको मार्कड वेबडॉक्स के आगे के विकास और GitHub सेवा के साथ इसके एकीकरण की पेशकश करता हूं।
क्या हुआ: पाठ प्रारूपण मार्कडाउन + html + घटकों के साथ, बिल्ट-इन एडिटर (और न केवल पृष्ठ का पाठ, बल्कि साइट की संरचना) के साथ, अतिरिक्त सेवाओं / सर्वर / डेटाबेस के बिना, काफी सरल, कुछ विकि-जैसा (संपादन के दृष्टिकोण में)। Git (हब) और फाइलों पर आधारित, वास्तव में एक CMS सिस्टम है जो एक सामान्य रिपॉजिटरी (रीड डिफरेंसेस, ऑटोमैटिक कमिट्स, पूल रिक्वेस्ट्स संभव है) के साथ डिस्ट्रीब्यूटेड वर्क की संभावना के साथ डॉक्यूमेंटेशन, सरल साइट्स या वेब एप्लिकेशन बनाने पर केंद्रित है।

यदि आप इस सेवा का उपयोग करते हैं, तो आप सबसे अधिक संभावना इस अवसर को जानते हैं, GitHub प्रत्येक उपयोगकर्ता को * .imtqy.com में एक तृतीय-स्तरीय डोमेन के साथ एक साइट बनाने का अवसर देता है, बशर्ते कि यह सामग्री खुले लाइसेंस में से एक के तहत उस पर रखी गई हो। यदि हम संदर्भ सामग्री लिखते हैं, तो हम उन्हें एक खुले लाइसेंस के तहत अच्छी तरह से प्रकाशित कर सकते हैं (उदाहरण के लिए, कलात्मक लाइसेंस 2.0) और उन्हें प्रकाशित करने के लिए निशुल्क गीथहब पेज सेवा का उपयोग करें।

डिफ़ॉल्ट रूप से, GitHub कुछ ही क्लिक में एक अच्छी नज़र के साथ एक स्थिर वेबसाइट बनाने की क्षमता प्रदान करता है। और यह बहुत अच्छा काम करता है अगर आपको दो बटन वाले एक पृष्ठ की आवश्यकता है। हालांकि, यदि आप अधिक पृष्ठों के साथ एक वेबसाइट बनाना चाहते हैं, और यहां तक ​​कि बाहरी लोगों के साथ इसे पूरक करने का अवसर देते हैं, तो यह इतना सुविधाजनक नहीं है। पहले से ही कुछ प्रकार के सीएमएस की आवश्यकता है, हम विकल्पों को सुलझाना शुरू करते हैं। मैं html कोड नहीं, पाठ को संपादित करना चाहता हूं। और मैं एक बार फिर से विभिन्न जटिल प्रणालियों या बाहरी सेवाओं के साथ संवाद नहीं करना चाहता। चित्रों के साथ पाठ के एक पृष्ठ को प्रकाशित करते समय क्या प्रणाली उचित होगी, क्या यह बिना तकनीकी परिवर्तन के जटिल दस्तावेज बनाने की अनुमति देगा, और विभिन्न प्लेटफार्मों पर उपयोग करने के लिए सीमित नहीं होगा?

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

इसके साथ खुद को परिचित करने के निर्देश

मार्कडाउन वेबदॉक्स पर अपनी साइट बनाना सरल है, आपको तीन चरण करने होंगे:

1) हम इस पते पर रिपॉजिटरी में जाते हैं github.com/aplib/docs-ru और फोर्क बटन के साथ ऊपरी दाएं कोने में स्थित है।



एक फोर्क डॉक्स-आरआर आपके रिपॉजिटरी के बीच दिखाई देगा, और थोड़ी देर (दस मिनट से अधिक नहीं) के बाद, यह GitHub पेज के माध्यम से यूजरनेम। Github.io पर आपके व्यक्तिगत पते पर एक ब्राउज़र द्वारा देखने के लिए सुलभ हो जाएगा। यही है, आप स्वचालित रूप से मेरी साइट की एक प्रति बनाते हैं और इसे नेटवर्क पर प्रकाशित करते हैं। आप अपने कांटे के सेटिंग सेक्शन में अपनी साइट का लिंक देख सकते हैं (रिपॉजिटरी व्यूइंग विंडो में निचले दाईं ओर सेटिंग्स)। यदि साइट लंबे समय तक दिखाई नहीं देती है, तो आप रिपॉजिटरी में कुछ फ़ाइल को बदलकर और पहली प्रतिबद्ध बनाकर इसे गति दे सकते हैं।



2) ऑनलाइन अपनी वेबसाइट पर नए पेजों को संपादित करने और बनाने में सक्षम होने के लिए, अपने खाते में उपयोगकर्ता नाम.जीथबूब.आईओ के साथ एक और रिपॉजिटरी बनाएं (उपयोगकर्ता नाम के बजाय आपको अपने उपनाम को गिथब पर प्रतिस्थापित करने की आवश्यकता है, उदाहरण में यह veensun.imtqy.com है ), और /username.imtqy.com सबफ़ोल्डर से फ़ाइलों को कॉपी करें

3) GitHub को पेज भेजते समय पासवर्ड के बजाय पर्सनल एक्सेस टोकन का उपयोग करना सुरक्षित होगा। आप इसे यहाँ github.com/settings/applications पर प्राप्त कर सकते हैं। टोकन में एक्सेस राइट्स को कॉन्फ़िगर करने की क्षमता है, इसकी मदद से (भले ही इसे हटा लिया गया हो), आप पासवर्ड नहीं बदल सकते, आप किसी रिपॉजिटरी को डिलीट नहीं कर सकते हैं या किसी अकाउंट को नष्ट नहीं कर सकते हैं। और किसी भी समय, आप मौजूदा एक को रद्द कर सकते हैं या एक नया टोकन बना सकते हैं।

एक मौजूदा पृष्ठ का संपादन

हम पृष्ठ पर जाते हैं, आप Ctrl + F12 द्वारा ऑन-लाइन संपादक या "इस पृष्ठ को संपादित करें" लिंक पर क्लिक करके खोल सकते हैं



अगला, संपादक में "सामग्री-पैनल" बुकमार्क (उदाहरण के लिए) पर जाएं और नया पाठ दर्ज करें। जब आप पृष्ठ को संपादित करते हैं, तो परिवर्तन स्वचालित रूप से ब्राउज़र में स्थानीय रूप से सहेजे जाते हैं। आप ऑनलाइन संपादक में GitHub बटन पर क्लिक करके रिपॉजिटरी में परिवर्तन लिख सकते हैं, किए गए परिवर्तनों के साथ एक कमिट स्वचालित रूप से बनाई जाएगी। आपके द्वारा बदलाव करने और कमिट करने के बाद, दस से दो सेकंड में साइट के आपके संस्करण पर परिवर्तन दिखाई देने लगते हैं।

एक नया पेज बनाएँ

आप अपने ब्राउज़र के एड्रेस बार में उनका पता लिखकर पेज बना सकते हैं। ब्राउज़र के एड्रेस बार में पेज का पता एक्सटेंशन .html के साथ समाप्त हो सकता है, .html के बिना टाइप किया जा सकता है, दोनों विकल्प सही होंगे। उदाहरण के लिए, मैं एड्रेस बार में aplib.imtqy.com/docs-ru/test टाइप कर सकता हूं (बेशक, आपके रिपॉजिटरी या फोर्क का लिंक थोड़ा अलग होगा)। खुलने वाले सेवा पृष्ठ पर, एक "पृष्ठ बनाएँ" बटन होगा, उस पर क्लिक करें और बस हमारे नए पृष्ठ के प्रकट होने की प्रतीक्षा करें, जिसके बाद हम इसे संपादित करना शुरू कर सकते हैं।

आपके द्वारा परिवर्तन किए जाने के बाद, आप अपने fork पृष्ठ को github.com पर खोल सकते हैं और इन परिवर्तनों को मूल भंडार से पुर्न-अनुरोध भेज सकते हैं जहाँ से कांटा बनाया गया था। इस प्रकार, कई उपयोगकर्ता साझा दस्तावेजों के साथ सुरक्षित रूप से काम कर सकते हैं। (कृपया मुझे अपने प्रयोगों का पूल अनुरोध न भेजें, अन्यथा मुझे स्थानीय प्रभाव पड़ेगा)

HTML में स्थानीय रूप से काम करें और संकलित करें

इस तकनीक का उपयोग करके बनाए गए दस्तावेज़ीकरण को स्थानीय रिपॉजिटरी क्लोन में संपादित किया जा सकता है और तैयार HTML में संकलित किया जा सकता है, जिसके पृष्ठ तेजी से लोड होंगे। ऐसा करने के लिए, अपने कंप्यूटर पर स्थानीय रिपॉजिटरी क्लोन में, नोड-वेबकिट का उपयोग करके देखने के लिए पृष्ठ खोलें, निर्मित संपादक को खोलें और पृष्ठ को संकलित फ़ॉर्म ".html + .mw.html" में फिर से सहेजें।
एक छोटा सा नोट: मार्कडाउन सिस्टम वेबडॉक्स में, यदि आप स्थानीय रूप से पेज बनाते या संपादित करते हैं, तो डॉक्यूमेंट टैग के लिए रूट और src विशेषताओं को सही ढंग से असाइन करना न भूलें। "रूट" (वैकल्पिक) साइट / लाइब्रेरी के रूट फ़ोल्डर के सापेक्ष पथ है और उचित लिंक के गठन के लिए आवश्यक है, "src" लाइब्रेरी फ़ाइल के सापेक्ष पथ है।

खोज इंजन अनुक्रमण

खोज रोबोट के लिए, यह HTML में संकलित कम से कम एक पृष्ठ बनाने के लिए पर्याप्त है (साइट के आंतरिक लिंक के रूप में .html + .mw.html को सहेजा गया) और इसमें बाहरी आवक लिंक हैं।

* * *

Aplib.imtqy.com/docs-ru साइट का एक उदाहरण इस तरह से बनाया गया है
मार्कडाउन वेबडॉक्स केवल मार्कडाउन से अधिक है, यह एक एक्स्टेंसिबल मार्कअप भाषा है। Aplib.imtqy.com/markdown-site-template प्रोजेक्ट की होम साइट पर घटकों के उदाहरण; उनका उपयोग करने के लिए, आपको उन्हें साइट के फ़ोल्डर में कॉपी करने की आवश्यकता है।
तकनीकी रूप से, निश्चित रूप से, मेरे पास आलोचना करने के लिए कुछ है, लेकिन अभी तक यह आवश्यक नहीं है। कुछ चीजें परियोजना के हालिया लॉन्च के कारण हैं और बाद में तय की जाएंगी।

प्रयास करें, प्रश्न पूछें, सभी संपर्क प्रोफ़ाइल में प्रकाशित किए गए हैं। या वहाँ सवाल और राय लिखें github.com/aplib/docs-ru/issues (रूसी में)।

* * *

अपडेट: यह पता चला है कि कांटा बनने के तुरंत बाद, आपकी साइट पर / doc-ru / * तब तक उपलब्ध नहीं हो सकती है जब तक कि पहला कमिट निष्पादित नहीं हो जाता है। इसलिए, आपको रिपॉजिटरी में जाने और कुछ मामूली बदलाव करने की आवश्यकता है। भविष्य में, इस सुविधा को इंस्टॉलर में ध्यान में रखा जाएगा।