Docmd: Markdown को सरल और संक्षिप्त दस्तावेज़ों में तेज़ी से परिवर्तित करने वाली एक वेबसाइट।
Docmd एक स्टैटिक डॉक्यूमेंटेशन जनरेशन टूल है जिसे Node.js पर आधारित करके विकसित किया गया है और इसका उद्देश्य "शून्य अव्यवस्था, केवल सामग्री" के सिद्धांत को साकार करना है। यह सरल टेक्स्ट मार्कडाउन फ़ाइलों को कुशलतापूर्वक रिस्पॉन्सिव और आकर्षक डॉक्यूमेंटेशन वेबसाइटों में परिवर्तित करता है, जिससे डेवलपर्स जटिल कॉन्फ़िगरेशन में समय बर्बाद करने से बच जाते हैं और पूरी तरह से सामग्री निर्माण पर ध्यान केंद्रित कर पाते हैं।
मूलभूत प्रकार्य
- मार्कडाउन नेटिव ड्राइवर: यह मार्कडाउन सिंटैक्स और YAML फ्रंटमैटर को सपोर्ट करता है, जिससे कंटेंट का स्वचालित HTML रूपांतरण संभव हो पाता है।
- हल्का आर्किटेक्चर: स्थैतिक जनरेशन योजना को अपनाने से, JS निर्भरताओं में काफी कमी आती है, जिससे पेज लोड होने की गति तेज होती है और प्रदर्शन स्थिर रहता है।
- दृश्य अनुभव: इसमें कई अंतर्निर्मित थीम हैं, कोड सिंटैक्स हाइलाइटिंग का समर्थन करता है और लाइट और डार्क मोड के बीच स्वचालित रूप से स्विच करने की सुविधा है।
- उन्नत घटक और एसईओ: यह टूलटिप्स, कार्ड और स्टेप्स जैसे अनुकूलन योग्य घटक प्रदान करता है; और इसमें सर्च इंजन विजिबिलिटी को बेहतर बनाने के लिए बिल्ट-इन साइटमैप, एनालिटिक्स और एसईओ प्लगइन्स शामिल हैं।
- लचीली तैनाती: उत्पन्न की गई स्थिर फ़ाइलों को Vercel, Netlify या GitHub Pages पर आसानी से होस्ट किया जा सकता है, और ये कस्टम डोमेन को जोड़ने का समर्थन करती हैं।
जल्दी से शुरुआत करें
1. स्थापना उपकरण
इसे npm के माध्यम से वैश्विक स्तर पर या प्रोजेक्ट के भीतर स्थानीय रूप से स्थापित किया जा सकता है:
# 全局安装 npm install -g @mgks/docmd # 本地开发依赖安装 npm install --save-dev @mgks/docmd2. मुख्य निर्देश
आरंभ से लेकर परिनियोजन तक की पूरी प्रक्रिया केवल तीन कमांड से पूरी की जा सकती है:
docmd init # 初始化项目配置 docmd dev # 启动本地预览服务 docmd build # उत्पादन वातावरण के लिए एक स्थिर संस्करण बनाएं लागू परिदृश्य
- तकनीकी दस्तावेज: ओपन-सोर्स प्रोजेक्ट्स के लिए API डॉक्यूमेंटेशन, प्रोडक्ट मैनुअल या Readme एक्सटेंशन पेज जल्दी से बनाएं।
- ज्ञान प्रबंधन: अपने व्यक्तिगत मार्कडाउन नोट्स या टीम के आंतरिक विकी को एक ऐसी वेबसाइट में बदलें जिसे ऑनलाइन एक्सेस किया जा सके।
- सामग्री निर्माण: यह उन रचनाकारों के लिए उपयुक्त है जो न्यूनतम शैली को अपनाते हैं और जटिल सीएमएस से परेशान नहीं होना चाहते हैं।
संबंधित संसाधन
आधिकारिक वेबसाइट का अनुभव:docmd .mgks.dev
GitHub स्रोत कोड:github.com/mgks/docmd
पाठ का अंत
