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

github-markdown-css एक छोटा CSS पैकेज है जिसका उद्देश्य GitHub द्वारा रेंडर किए गए Markdown पर लागू की जाने वाली दृश्य शैली को पुनः उत्पन्न करना है, जिसमें न्यूनतम आवश्यक CSS का उपयोग किया जाता है। यह स्टाइलशीट हाथ से संपादित नहीं है, बल्कि जनरेट की जाती है; README योगदान को अलग generate-github-markdown-css रिपॉजिटरी में निर्देशित करता है। उपयोग सीधा है: github-markdown.css आयात करें, अपने रेंडर किए गए Markdown वाले कंटेनर में markdown-body क्लास जोड़ें, और चौड़ाई सेट करें। README नोट करता है कि GitHub 980px चौड़ाई और 45px पैडिंग का उपयोग करता है, और मोबाइल पर 15px पैडिंग, और box-sizing, min-width, max-width, margin auto, और संकीर्ण व्यूपोर्ट के लिए मीडिया क्वेरी के साथ एक उदाहरण प्रदान करता है। prefers-color-scheme के माध्यम से एक डार्क-मोड पृष्ठभूमि रंग भी दिखाया गया है। पैकेज में सात थीम शामिल हैं: एक डिफ़ॉल्ट जो prefers-color-scheme के माध्यम से स्वचालित रूप से लाइट और डार्क के बीच स्विच करता है, केवल-लाइट, केवल-डार्क, डार्क डिम्ड, डार्क हाई कंट्रास्ट, डार्क कलरब्लाइंड (प्रोटानोपिया और ड्यूटेरानोपिया), और लाइट कलरब्लाइंड वेरिएंट। इन शैलियों से मेल खाने वाले HTML के लिए, README GitHub के /markdown API का सुझाव देता है, जो GitHub द्वारा स्वयं उत्पन्न HTML बनाता है। यह नोट करता है कि अन्य Markdown पार्सर भी ज्यादातर शैलियों के साथ काम करेंगे, और GitHub की नकल करने वाले कोड हाइलाइटिंग के लिए starry-night की सिफारिश करता है। इंस्टॉलेशन विकल्पों में फ़ाइल को मैन्युअल रूप से डाउनलोड करना, CDNJS का उपयोग करना, या npm install github-markdown-css शामिल है। एक डेमो पेज लिंक किया गया है। एक समस्या-निवारण नोट बताता है कि डार्क मोड में काली टेबल फ़ॉन्ट जैसी स्टाइलिंग समस्याएं ब्राउज़र के क्विर्क्स मोड में गिरने के कारण हो सकती हैं; पृष्ठ के शीर्ष पर एक doctype शामिल करने से यह समस्या टल जाती है। विकास के लिए, npm run make CSS को अपडेट करता है।