প্রকল্প সম্পর্কে

মার্কডাউন-ভিউয়ার (বাইনারি নাম `mdv`) একটি স্থানীয় মার্কডাউন ভিউয়ার এবং ফাইল ব্রাউজার যা একটি একক বাইনারি হিসাবে বিতরণ করা হয়। এটি একটি স্থানীয় HTTP ঠিকানার মাধ্যমে মার্কডাউন ফাইলের একটি ডিরেক্টরি পরিবেশন করে এবং একটি দ্বি-প্যানেল ইন্টারফেস উপস্থাপন করে: বাম দিকে একটি প্রসারণযোগ্য, স্থায়ী ফাইল ট্রি এবং ডান দিকে রেন্ডার করা বিষয়বস্তু। রেন্ডারিং গিটহাব ফ্লেভারড মার্কডাউনকে গিটহাব-সদৃশ স্টাইলিং, সিনট্যাক্স-হাইলাইটেড কোড ব্লক এবং বান্ডেল করা Mermaid ডায়াগ্রাম সমর্থন সহ কভার করে। সমস্ত UI সম্পদ — CSS, JavaScript এবং 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 Mac সোর্স থেকে বিল্ড করতে পারে। রিপোজিটরিতে CHANGELOG.md এবং তৃতীয়-পক্ষের লাইসেন্স অ্যাট্রিবিউশন সহ NOTICE.md অন্তর্ভুক্ত রয়েছে।