जावास्क्रिप्ट ट्यूटोरियल - गितुब पर

सभी को नमस्कार!

कुछ समय पहले, मैंने एक आधुनिक जावास्क्रिप्ट पाठ्यपुस्तक के अल्फा संस्करण के बारे में एक विषय प्रकाशित किया, जबकि अंग्रेजी में: javascript.info ।

टिप्पणियों ने विशेष रूप से इच्छा व्यक्त की:

• पुस्तक के स्रोत कोड को खुले स्रोत में रखें।
• एक ऑफ़लाइन संस्करण बनाएं।
• गीथब पर एक किताब पर सहयोग करना संभव बनाएं।

यह सब किया जाता है। अगला चरण रूसी में सहयोग और अनुवाद है।


Github.com/iliakan/javascript-book रिपॉजिटरी में पहले से ही ऑफ़लाइन और ओपन-सोर्स जावास्क्रिप्ट पुस्तक का एक अल्फा संस्करण है जिसे इंटरनेट के बिना कुक आइलैंड्स पर भी पढ़ा जा सकता है। और सभी इंटरैक्टिव उदाहरण काम करेंगे।

आप इसे संपादित भी कर सकते हैं और अपडेट भेज सकते हैं, और विशेष रूप से - अनुवाद कर सकते हैं।

मैं अपने विचारों को साझा करना चाहूंगा कि पाठ्यपुस्तक के विकास के लिए गितूब को क्यों अपनाया गया था।

विकी

सहयोगी संपादन के लिए एक स्पष्ट विकल्प एक विकी है। इस मामले में, विकी उपयुक्त नहीं है, क्योंकि पाठ्यपुस्तक को वैचारिक रूप से समग्र होना चाहिए।

यह विश्वकोश के स्वतंत्र पृष्ठों का एक गुच्छा नहीं है, बल्कि एक सुसंगत प्रस्तुति है। यही है, आपको एक संपादक की आवश्यकता है जो पूरी तस्वीर को ध्यान में रखता है, परिवर्तन को स्वीकार करता है और विलय करता है।

यदि पाठ्यपुस्तक में कई स्वतंत्र खंड हैं तो कई संपादक हो सकते हैं।

खुद का ऑनलाइन सिस्टम

अगला विचार एक सह-संपादन प्रणाली बनाना है जो ऊपर लिखी गई आवश्यकताओं को पूरा करती है।

मुख्य शाखा के साथ प्रलेखन का एक प्रकार का सहयोगात्मक संपादन, जिसमें केवल मुख्य संपादक और अनुभाग संपादक हैं। यह काफी सरल है, ऐसी प्रणालियों के लिए सभी आवश्यक घटक हैं।

हालांकि, ट्यूटोरियल की ख़ासियत यह है कि HTML / JS / CSS के कई उदाहरण होने चाहिए। अधिमानतः संवादात्मक। और यह ऑफ़लाइन लिखने और उन्हें डिस्क पर ऑफ़लाइन परीक्षण करने के लिए सुविधाजनक है - ऑनलाइन माध्यम से नहीं।

अंतिम विकल्प

अंतिम संस्करण के रूप में, जीआईटी रिपॉजिटरी और ट्यूटोरियल के एक ऑफ़लाइन संस्करण, जिसमें सभी स्क्रिप्ट, उदाहरण, चित्र आदि शामिल हैं, का चयन किया गया था।

इस दृष्टिकोण की जटिलता यह है कि संपादन के लिए Git का ज्ञान वांछनीय है (पढ़ने के लिए, आप बस संग्रह डाउनलोड कर सकते हैं)।

कम से कम, Git को क्लोन पर स्थापित करें, और फिर git diff और परिवर्तन पोस्ट करें। और बेहतर - पुल अनुरोधों के लिए पूर्ण ज्ञान। यह संपादकों के लिए प्रवेश सीमा को बढ़ाता है।

प्लसस - यह स्पष्ट है कि किसने क्या भेजा, गितुब पर चर्चा, मुद्दों, पुल अनुरोधों - सभी बुनियादी ढांचे।

एक ऑफ़लाइन संस्करण बनाने की मुख्य तकनीकी कठिनाई यह थी कि पुस्तक को न केवल रखा जाना चाहिए, बल्कि परिवर्तनों को स्थानीय रूप से देखने, संपादित करने और देखने का अवसर भी दिया जाना चाहिए।

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

एक सुंदर, पूरी तरह से काम करने वाले पृष्ठ को देखने के लिए संभव बनाने के लिए, स्वरूपण को शुद्ध जेएस को फिर से लिखा गया। उसी समय, उदाहरणों को लोड करने और हाइलाइट करने के लिए, स्थानीय XmlHttpRequest + Patched Syntaxhighlighter का उपयोग किया जाता है । हाइलाइटर संस्करण 3 पाठ की पंक्तियों को लपेटने में सक्षम नहीं है, इसलिए संस्करण 2।
यदि आपके पास कोई विचार है, तो 3 पर स्विच करना बेहतर क्यों है - मुझे सुनने में खुशी होगी।

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

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

अब ओपन-सोर्स ट्यूटोरियल को Github github.com/iliakan/javascript-book में डाउनलोड, देखा, संपादित और परिवर्तन / अनुवाद भेजा जा सकता है।

यदि आपके कोई प्रश्न या सुझाव हैं तो लिखें ... हां, वैसे, एक रीडमी है, मैं इसे पूरक करूंगा।

- सबसे अच्छा संबंध है,
इलिया कांतोर