इस प्रोजेक्ट के बारे में

Ciderpress मोनोरेपो के लिए डिज़ाइन किया गया एक दस्तावेज़ीकरण फ्रेमवर्क है जो न्यूनतम कॉन्फ़िगरेशन के साथ मार्कडाउन फ़ाइलों को एक संपूर्ण दस्तावेज़ीकरण साइट में बदलता है। मुख्य क्षमताएं: - संरचना अनुरूपता: कठोर संरचना थोपने के बजाय आपकी मौजूदा रिपॉजिटरी लेआउट के अनुसार स्वयं को अनुकूलित करता है। - एकीकृत कॉन्फ़िगरेशन: साइडबार, नेविगेशन, फ़ुटर, संपादन लिंक, संस्करण प्रदर्शन, घोषणाएं और थीमिंग एक ही कॉन्फ़िगरेशन फ़ाइल से नियंत्रित होते हैं। - अंतर्निहित थीम: इसमें honeycrisp, grannysmith, midnight और arcade—चार थीम शामिल हैं, जिनमें से प्रत्येक में संपूर्ण डार्क-मोड समर्थन है। कस्टम थीम भी समर्थित हैं। - मोनोरेपो समर्थन: इसमें वर्कस्पेस कार्ड, OpenAPI एकीकरण और Liquid टेम्पलेट समर्थन शामिल है, जो आंतरिक डेवलपर दस्तावेज़ीकरण को लक्षित करता है। उपयोग के लिए npm के माध्यम से इंस्टॉल करना और एक कॉन्फ़िगरेशन फ़ाइल (ciderpress.config.ts) परिभाषित करना आवश्यक है जो शीर्षक, पथ और मार्कडाउन इनक्लूड पैटर्न के साथ सेक्शन घोषित करती है। यह टूल तीन कमांड प्रदान करता है: हॉट रीलोड के साथ डेवलपमेंट सर्वर शुरू करने के लिए `npx ciderpress dev`, प्रोडक्शन बिल्ड जनरेट करने के लिए `npx ciderpress build`, और निर्मित साइट को स्थानीय रूप से पूर्वावलोकन करने के लिए `npx ciderpress serve`। MIT लाइसेंस के अंतर्गत लाइसेंस प्राप्त।