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
```
इसे कैसे पढ़ें:
flowchart TDका मतलब है ऊपर से नीचे। बाएं से दाएं के लिएLRका उपयोग करो।flowchartकी जगहgraphशब्द भी चलता है।Start[Write the note]एक बॉक्स बनाता है।Startछोटा नाम है। कोष्ठक में लिखा टेक्स्ट लेबल है।- घुंघराले कोष्ठक
{ }निर्णय का आकार, यानी हीरा, बनाते हैं। -->तीर बनाता है। पाइप के बीच का टेक्स्ट, जैसे|Yes|, तीर को लेबल देता है।
उदाहरण 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
```
participant U as UserUser नाम का एक कॉलम बनाता है। छोटा नामUहै।->>ठोस तीर है।-->>बिंदीदार तीर है, जो अक्सर जवाबों के लिए इस्तेमाल होता है।- कोलन के बाद का टेक्स्ट संदेश है।
- संदेश ऊपर से नीचे उसी क्रम में बनाए जाते हैं जिसमें तुम उन्हें लिखते हो।
उदाहरण 3: पाई चार्ट
```mermaid
pie title Time spent on a project
"Writing" : 40
"Reading" : 25
"Meetings" : 15
"Other" : 20
```
हर टुकड़ा उद्धरण चिह्नों में एक लेबल, एक कोलन और एक संख्या होता है। संख्या शून्य से ज़्यादा होनी चाहिए।
डायग्राम के दूसरे प्रकार
Mermaid और भी कई तरह के डायग्राम बना सकता है। आम वाले:
- गैंट चार्ट: टाइमलाइन पर काम।
- क्लास डायग्राम: कोड में क्लास और वे कैसे जुड़ी हैं।
- स्टेट डायग्राम: किसी चीज़ की अवस्थाएं और वह उनके बीच कैसे जाती है।
- एंटिटी रिलेशनशिप डायग्राम: डेटाबेस की तालिकाएं और लिंक।
- यूज़र जर्नी: किसी व्यक्ति के उठाए कदम।
- माइंडमैप: एक केंद्र से निकलते विचार।
- टाइमलाइन: तारीख के क्रम में घटनाएं।
- Git ग्राफ़: ब्रांच और कमिट।
हर प्रकार का अपना पहला शब्द और अपने नियम होते हैं। Mermaid के दस्तावेज़ों में हर एक के लिए एक पेज है।
Mermaid डायग्राम कहां बनाए जाते हैं
GitHub, Markdown फ़ाइलों, इश्यू, चर्चाओं, पुल रिक्वेस्ट और विकी में Mermaid ब्लॉक बनाता है। तुम्हें बस mermaid कोड ब्लॉक चाहिए। कई Markdown एडिटर और नोट ऐप भी Mermaid को समर्थन देते हैं, लेकिन सभी नहीं।
जब कोई रीडर Mermaid को समर्थन नहीं देता, तो वह आमतौर पर ब्लॉक को किसी भी दूसरे कोड की तरह मानता है। तुम्हें तस्वीर की जगह वह टेक्स्ट दिखता है जो तुमने लिखा। कुछ खोता नहीं। बस वह बनाया नहीं जाता।
आम गलतियां
- एक छोटी वर्तनी की गलती पूरे डायग्राम को बिगाड़ देती है। अज्ञात या गलत वर्तनी वाले कीवर्ड उसे बनने से रोकते हैं। अगर तुम्हें त्रुटि या सादा टेक्स्ट दिखे, तो पहले पहली लाइन और तीर जांचो।
- लेबल में विशेष वर्ण। कोष्ठक और ऐसे ही वर्ण पार्सर को उलझा सकते हैं। लेबल को उद्धरण चिह्नों में रखो:
A["Save (draft)"]। - फ़्लोचार्ट में शब्द
end। छोटे अक्षरों मेंendफ़्लोचार्ट को बिगाड़ देता है।EndयाENDलिखो, या शब्द को उद्धरण चिह्नों में रखो। यह सीक्वेंस डायग्राम में भी परेशानी कर सकता है। - गलत फ़ेंस। बैकटिक के बाद की भाषा
mermaidहोनी चाहिए। इसके बिना रीडर को सादा कोड ब्लॉक दिखता है।
इंडेंटेशन की ज़रूरत नहीं है। ज़्यादातर लोग डायग्राम के भीतर की लाइनें केवल इसलिए इंडेंट करते हैं क्योंकि इससे पढ़ना आसान होता है।
AI चैट और एजेंट Mermaid लिखते हैं
AI चैट और कोडिंग एजेंट अक्सर योजनाओं, स्पेक और डिज़ाइन नोट में Mermaid रखते हैं। फ़्लोचार्ट चरण दिखाने का एक तेज़ तरीका है। सीक्वेंस डायग्राम दिखाता है कि किसी सिस्टम के हिस्से आपस में कैसे बात करते हैं।
अगर कोई चैट तुम्हें डायग्राम देती है, तो पूरा कोड ब्लॉक, फ़ेंस समेत, अपनी Markdown फ़ाइल में कॉपी करो। अगर डायग्राम नहीं बनता, तो उसे ऊपर की गलतियों से मिलाकर जांचो। छोटे लेबल और हर डायग्राम में एक विचार रखने से टेक्स्ट को ठीक करना आसान हो जाता है।
Mermaid डायग्राम पढ़ना
PilcrowMD Android और Mac पर Mermaid डायग्राम बनाता है, इंटरनेट की ज़रूरत नहीं। Android पर, डायग्राम को फ़ुल स्क्रीन में देखने के लिए उस पर टैप करो। Mac पर, Quick Look, Compare और PDF तस्वीर की जगह कोड ब्लॉक दिखाते हैं।
आम सवाल
क्या Mermaid लिखने के लिए मुझे कुछ इंस्टॉल करना होगा? नहीं। तुम कोड ब्लॉक में सादा टेक्स्ट लिखते हो। तुम्हें बस एक ऐसा रीडर चाहिए जो उसे बनाए।
मुझे डायग्राम की जगह कोड क्यों दिखता है? या तो रीडर Mermaid को समर्थन नहीं देता, या डायग्राम में सिंटैक्स की गलती है। जांचो कि ब्लॉक mermaid से शुरू होता है और पहली लाइन किसी असली डायग्राम प्रकार का नाम बताती है।
क्या मैं डायग्राम का रूप बदल सकता हूं? हां। Mermaid में रंगों, आकारों और लेआउट के विकल्प हैं। डिफ़ॉल्ट से शुरू करो। ज़्यादातर नोट के लिए वे काफ़ी हैं।
Mac पर भी: Mac के लिए PilcrowMD (बीटा)