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

markdown-viewer (बाइनरी नाम `mdv`) एक स्थानीय मार्कडाउन व्यूअर और फ़ाइल ब्राउज़र है जो एक एकल बाइनरी के रूप में वितरित किया जाता है। यह एक स्थानीय HTTP पते पर मार्कडाउन फ़ाइलों की एक निर्देशिका प्रस्तुत करता है और एक दो-पैनल इंटरफ़ेस प्रस्तुत करता है: बाईं ओर एक विस्तार योग्य, स्थायी फ़ाइल ट्री और दाईं ओर रेंडर की गई सामग्री। रेंडरिंग में GitHub-शैली स्टाइलिंग के साथ GitHub फ्लेवर्ड मार्कडाउन, सिंटैक्स-हाइलाइटेड कोड ब्लॉक और बंडल किए गए Mermaid आरेख समर्थन शामिल है। सभी UI संपत्तियां — CSS, जावास्क्रिप्ट और HTML टेम्पलेट — बाइनरी में एम्बेडेड हैं, इसलिए किसी बाहरी निर्भरता या अलग स्थापना चरणों की आवश्यकता नहीं है। सुरक्षा डिफ़ॉल्ट में निर्देशिका-ट्रैवर्सल सुरक्षा और XSS के विरुद्ध HTML स्वच्छता शामिल है। शटडाउन को UI से या Ctrl+C के साथ ट्रिगर किया जा सकता है। स्थापना रिलीज़ पेज से लक्ष्य प्लेटफ़ॉर्म के लिए `mdv` बाइनरी डाउनलोड करके, संग्रह निकालकर और बाइनरी को PATH पर रखकर की जाती है। कॉन्फ़िगरेशन `config.json` फ़ाइल या कमांड-लाइन फ़्लैग से आ सकता है, जिसमें निम्नलिखित प्राथमिकता है (बाद वाला पिछले को ओवरराइड करता है): बिल्ट-इन डिफ़ॉल्ट, `$HOME/.config/mdv/config.json`, वर्तमान कार्यशील निर्देशिका में `config.json`, `MDV_` उपसर्ग वाले पर्यावरण चर (उदाहरण के लिए `MDV_PORT=9000`), और अंत में कमांड-लाइन फ़्लैग। एक `config.json.example` संदर्भ के रूप में प्रदान किया गया है। उपयोग मार्कडाउन फ़ाइलों वाली किसी भी निर्देशिका से `mdv` चलाना और ब्राउज़र में `http://127.0.0.1:8080` खोलना है। फ़्लैग में `-p, --port` (डिफ़ॉल्ट 8080), `-o, --open` ब्राउज़र को स्वचालित रूप से लॉन्च करने के लिए, `-d, --dir` रूट निर्देशिका सेट करने के लिए (डिफ़ॉल्ट `.`), और `--version` शामिल हैं। स्रोत से निर्माण के लिए Go 1.24 या बाद के संस्करण की आवश्यकता है। Make लक्ष्यों में वर्तमान प्लेटफ़ॉर्म के लिए `build`, क्रॉस-कम्पाइलेशन के लिए `build-all`, ज़िप संग्रह उत्पन्न करने के लिए `package`, `test`, और `clean` शामिल हैं। लक्ष्य प्लेटफ़ॉर्म linux/amd64, linux/arm64, darwin/arm64 और windows/amd64 हैं; macOS बिल्ड केवल arm64 हैं, जबकि Intel Macs स्रोत से निर्माण कर सकते हैं। रिपॉजिटरी में तृतीय-पक्ष लाइसेंस विशेषताओं के साथ CHANGELOG.md और NOTICE.md भी शामिल है।