Markdown में Mermaid डायग्राम

Mermaid टेक्स्ट से डायग्राम बनाने का एक तरीका है। तुम कुछ छोटी लाइनें लिखते हो। Mermaid को समर्थन देने वाला रीडर उन्हें एक तस्वीर में बदल देता है: फ़्लोचार्ट, टाइमलाइन, चार्ट।

तुम डायग्राम को सामान्य Markdown फ़ाइल के भीतर रख सकते हो। न कोई इमेज एक्सपोर्ट करनी है, न कोई ड्राइंग टूल खोलना है। डायग्राम बदलने के लिए तुम टेक्स्ट बदलते हो।

mermaid कोड ब्लॉक

Mermaid डायग्राम फ़ेंस वाले कोड ब्लॉक में रहता है। फ़ेंस का मतलब तीन बैकटिक है। खुलने वाली फ़ेंस के बाद भाषा के रूप में mermaid लिखो:

```mermaid
flowchart LR
    A --> B
```

ब्लॉक के भीतर की पहली लाइन बताती है कि यह किस तरह का डायग्राम है। यहां यह flowchart LR है। उस लाइन के बाद सब कुछ डायग्राम का वर्णन करता है।

%% से शुरू होने वाली लाइनें टिप्पणियां हैं। रीडर उन्हें अनदेखा करता है।

उदाहरण 1: निर्णय वाला फ़्लोचार्ट

```mermaid
flowchart TD
    Start[Write the note] --> Check{Is it clear?}
    Check -->|Yes| Publish[Share it]
    Check -->|No| Edit[Rewrite it]
    Edit --> Check
```

इसे कैसे पढ़ें:

उदाहरण 2: सीक्वेंस डायग्राम

सीक्वेंस डायग्राम दिखाता है कि कौन किससे, किस क्रम में बात करता है।

```mermaid
sequenceDiagram
    participant U as User
    participant S as Server
    U->>S: Open the page
    S-->>U: Send the page
    U->>S: Log in
    S-->>U: Welcome
```

उदाहरण 3: पाई चार्ट

```mermaid
pie title Time spent on a project
    "Writing" : 40
    "Reading" : 25
    "Meetings" : 15
    "Other" : 20
```

हर टुकड़ा उद्धरण चिह्नों में एक लेबल, एक कोलन और एक संख्या होता है। संख्या शून्य से ज़्यादा होनी चाहिए।

डायग्राम के दूसरे प्रकार

Mermaid और भी कई तरह के डायग्राम बना सकता है। आम वाले:

हर प्रकार का अपना पहला शब्द और अपने नियम होते हैं। Mermaid के दस्तावेज़ों में हर एक के लिए एक पेज है।

Mermaid डायग्राम कहां बनाए जाते हैं

GitHub, Markdown फ़ाइलों, इश्यू, चर्चाओं, पुल रिक्वेस्ट और विकी में Mermaid ब्लॉक बनाता है। तुम्हें बस mermaid कोड ब्लॉक चाहिए। कई Markdown एडिटर और नोट ऐप भी Mermaid को समर्थन देते हैं, लेकिन सभी नहीं।

जब कोई रीडर Mermaid को समर्थन नहीं देता, तो वह आमतौर पर ब्लॉक को किसी भी दूसरे कोड की तरह मानता है। तुम्हें तस्वीर की जगह वह टेक्स्ट दिखता है जो तुमने लिखा। कुछ खोता नहीं। बस वह बनाया नहीं जाता।

आम गलतियां

इंडेंटेशन की ज़रूरत नहीं है। ज़्यादातर लोग डायग्राम के भीतर की लाइनें केवल इसलिए इंडेंट करते हैं क्योंकि इससे पढ़ना आसान होता है।

AI चैट और एजेंट Mermaid लिखते हैं

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

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

Mermaid डायग्राम पढ़ना

PilcrowMD Android और Mac पर Mermaid डायग्राम बनाता है, इंटरनेट की ज़रूरत नहीं। Android पर, डायग्राम को फ़ुल स्क्रीन में देखने के लिए उस पर टैप करो। Mac पर, Quick Look, Compare और PDF तस्वीर की जगह कोड ब्लॉक दिखाते हैं।

आम सवाल

क्या Mermaid लिखने के लिए मुझे कुछ इंस्टॉल करना होगा? नहीं। तुम कोड ब्लॉक में सादा टेक्स्ट लिखते हो। तुम्हें बस एक ऐसा रीडर चाहिए जो उसे बनाए।

मुझे डायग्राम की जगह कोड क्यों दिखता है? या तो रीडर Mermaid को समर्थन नहीं देता, या डायग्राम में सिंटैक्स की गलती है। जांचो कि ब्लॉक mermaid से शुरू होता है और पहली लाइन किसी असली डायग्राम प्रकार का नाम बताती है।

क्या मैं डायग्राम का रूप बदल सकता हूं? हां। Mermaid में रंगों, आकारों और लेआउट के विकल्प हैं। डिफ़ॉल्ट से शुरू करो। ज़्यादातर नोट के लिए वे काफ़ी हैं।

Mac पर भी: Mac के लिए PilcrowMD (बीटा)