Mermaid एडिटर

यह टूल क्या है?

एक लाइव Mermaid डायग्राम एडिटर जो फ्लोचार्ट, सीक्वेंस डायग्राम, क्लास डायग्राम और अन्य को जब आप टाइप करते हैं रेंडर करता है। Mermaid सिंटैक्स का उपयोग करके डायग्राम को टेक्स्ट के रूप में लिखें और रेंडर किए गए परिणाम को तुरंत देखें, फिर इसे इमेज के रूप में एक्सपोर्ट करें।

उपयोग कैसे करें

1. एक टेम्पलेट चुनें (फ्लोचार्ट, सीक्वेंस, क्लास, आदि) उदाहरण Mermaid सिंटैक्स लोड करने के लिए, या अपना खुद का लिखें।
2. जब आप सिंटैक्स संपादित करते हैं तो डायग्राम प्रीव्यू स्वचालित रूप से अपडेट होता है।
3. डायग्राम को SVG, PNG या JPEG के रूप में डाउनलोड करने के लिए Export Image पर क्लिक करें, या Mermaid कोड कॉपी करने के लिए Copy Syntax पर क्लिक करें।
4. यदि सिंटैक्स में त्रुटि है, तो अंतिम मान्य डायग्राम दृश्यमान रहता है जबकि आप इसे ठीक करते हैं।

सामान्य उपयोग के मामले

• किसी प्रक्रिया या निर्णय वृक्ष के लिए फ्लोचार्ट स्केच करना
• API कॉल अनुक्रम या सिस्टम इंटरेक्शन को दस्तावेज़ित करना
• सॉफ्टवेयर डिज़ाइन के लिए क्लास डायग्राम या entity-relationship डायग्राम बनाना
• दस्तावेज़ीकरण या README फ़ाइलों में डायग्राम-as-कोड को एम्बेड करना

टिप्स और ट्रिक्स

• Mermaid सिंटैक्स सादा टेक्स्ट है, इसलिए डायग्राम आपके कोड के साथ version-controlled हो सकते हैं।
• दस्तावेज़ीकरण में स्पष्ट डायग्राम के लिए SVG एक्सपोर्ट का उपयोग करें, और chat या स्लाइड में त्वरित साझा करने के लिए PNG या JPEG का उपयोग करें।