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

Mermaid হলো একটি JavaScript-ভিত্তিক ডায়াগ্রামিং এবং চার্টিং টুল যা জটিল ডায়াগ্রাম তৈরি এবং পরিবর্তন করতে Markdown-অনুপ্রাণিত টেক্সট ডেফিনিশন এবং একটি রেন্ডারার ব্যবহার করে। এর প্রধান উদ্দেশ্য হলো ডায়াগ্রামগুলোকে টেক্সট হিসেবে সহজে পরিবর্তনযোগ্য করে তোলার মাধ্যমে ডকুমেন্টেশনকে ডেভেলপমেন্টের সাথে তাল মেলাতে সাহায্য করা। এই প্রজেক্টটি MIT লাইসেন্সের অধীনে ওপেন সোর্স এবং এটি একটি npm প্যাকেজ হিসেবে বিতরণ করা হয়। এর README-তে ২০টিরও বেশি ডায়াগ্রাম টাইপের সমর্থনের কথা উল্লেখ করা হয়েছে, যার মধ্যে রয়েছে Flowchart, Sequence, Class, State, ER, Gantt, Pie, Git Graph, Mindmap, Timeline এবং Sankey। ডায়াগ্রামগুলো ড্র্যাগ-অ্যান্ড-ড্রপ টুলের পরিবর্তে টেক্সট হিসেবে লেখা হয়, যাতে সেগুলো কোডের পাশাপাশি থাকতে পারে এবং ভার্সন কন্ট্রোলের মাধ্যমে রিভিউ করা যায়। প্রোটোটাইপিংয়ের জন্য প্রজেক্টটি mermaid.live-এ একটি লাইভ এডিটর প্রদান করে এবং GitHub-এর Markdown-এ Mermaid কোড ব্লকগুলো নেটিভলি রেন্ডার হয়। এটি অন্যান্য অ্যাপ্লিকেশন এবং ডকুমেন্টেশন টুলিংয়ের সাথে ইন্টিগ্রেশন সুবিধা প্রদান করে। কাস্টমাইজেশন অপশনের মধ্যে রয়েছে থিম, রঙ, ফন্ট এবং লেআউট ডিরেকশন। নিরাপত্তার জন্য, Mermaid-এ বিল্ট-ইন স্যানিটাইজেশন এবং একটি স্যান্ডবক্সড রেন্ডারিং মোড অন্তর্ভুক্ত রয়েছে, যেখানে ডায়াগ্রামগুলো একটি স্যান্ডবক্সড iframe-এ রেন্ডার করা হয় যাতে ব্যবহারকারীর কন্টেন্টে এমবেড করা JavaScript এক্সিকিউট হতে না পারে। README-তে উল্লেখ করা হয়েছে যে এই মোডটি সম্ভাব্য ক্ষতিকারক কোডের পাশাপাশি কিছু ইন্টারঅ্যাক্টিভ ফাংশনালিটিকেও ব্লক করতে পারে। প্রজেক্টটি নিজেকে কোনো ভারী ডিপেন্ডেন্সিহীন লাইটওয়েট টুল হিসেবে বর্ণনা করে এবং ঘন ঘন রিলিজের মাধ্যমে একটি সক্রিয় কমিউনিটি বজায় রাখে। সংশ্লিষ্ট প্রজেক্টগুলোর মধ্যে রয়েছে একটি Command Line Interface, Live Editor এবং একটি HTTP Server। রিপোজিটরি README-তে অফিসিয়াল ডকুমেন্টেশন, গেটিং স্টার্টেড গাইড, CDN প্রাপ্যতা, টিউটোরিয়াল এবং কন্ট্রিবিউটিং গাইডের কথা উল্লেখ করা হয়েছে। Mermaid ২০১৯ সালে JS Open Source Awards-এ 'most exciting use of technology' বিভাগে জয়লাভ করেছে।