Skip to main content

हमारे wiki में Markdown (CommonMark) का उपयोग कैसे करें

नोट: यह दस्तावेज़ मूल अंग्रेजी संस्करण का स्वचालित अनुवाद है।

यह पृष्ठ हमारे विकी में पृष्ठों को फ़ॉर्मेट करने के लिए एक छोटी "चीट शीट" है, जहाँ सामग्री CommonMark Markdown में लिखी जाती है।

मूल नियम

  • सरल, छोटे वाक्यों में लिखें।
  • पृष्ठ को स्कैन करने योग्य (आसानी से पढ़ने योग्य) बनाएं: शीर्षक + सूचियाँ + तालिकाएँ।
  • एक अनुभाग = एक विचार। "पाठ की दीवारों" (लंबे पैराग्राफ) से बचें।

शीर्षक

संरचना के लिए ## / ### / #### का उपयोग करें।

## अनुभाग
### उप-अनुभाग
#### उप-उप-अनुभाग

बोल्ड, इटैलिक, इनलाइन कोड

**बोल्ड**
*इटैलिक*
`कोड/फ़ील्ड/पता`

लिंक

[लिंक टेक्स्ट](https://example.com)

यदि आपको "कच्चा" (raw) लिंक दिखाना है (दुर्लभ):

`https://example.com`

सूचियाँ

बुलेटेड सूची:

- आइटम 1
- आइटम 2
  - उप-आइटम

संख्यांकित सूची:

1. चरण 1
2. चरण 2
3. चरण 3

उद्धरण / नोट्स

> यह एक महत्वपूर्ण नोट है।
> यह दो पंक्तियों का हो सकता है।

तालिकाएँ

न्यूनतम टेम्पलेट:

| फ़ील्ड | मान |
|---|---|
| नाम | [ ] |
| स्थिति | [ ] |

सुझाव:

  • विभाजक पंक्ति |---|---| अनिवार्य है।
  • तालिका कक्षों में **बोल्ड**, लिंक और कोड हो सकते हैं।

कोड और "कच्चे" (raw) पाठ ब्लॉक

कोड ब्लॉक:

\```text
पंक्ति 1
पंक्ति 2
\```

यदि यह एक विशिष्ट भाषा है (उदाहरण के लिए, JSON), तो आप इसे निर्दिष्ट कर सकते हैं:

\```json
{ "key": "value" }
\```

छवियाँ

यदि आपके पास सीधा छवि URL है:

![विवरण](https://example.com/image.png)

यदि फ़ाइल विकी पर अपलोड की गई है, तो अपलोड करने पर विकी द्वारा प्रदान किए गए लिंक/एम्बेड का उपयोग करें।

पंक्ति विराम (Line breaks) और पैराग्राफ

  • एक नया पैराग्राफ पैराग्राफ के बीच एक रिक्त पंक्ति होता है।
  • यदि आपको पैराग्राफ के भीतर पंक्ति विराम की आवश्यकता है, तो पंक्ति के अंत में दो रिक्त स्थान (spaces) जोड़ें:
पहली पंक्ति।  
दूसरी पंक्ति।

एंबेडेड HTML (सावधानी से उपयोग करें)

संक्षिप्त करने योग्य "विवरण" (Details) ब्लॉक

"पहली स्क्रीन" को ओवरलोड करने से बचने के लिए इसका उपयोग लंबे विवरण/साक्ष्यों के लिए करें।

<details>
<summary><b>विवरण</b></summary>

आप यहां पाठ, सूचियां और तालिकाएं रख सकते हैं।

</details>

पृष्ठ के भीतर एंकर और त्वरित लिंक

एंकर:

<a id="ai-thesis-fit"></a>

एंकर से लिंक:

[AI थीसिस फिट पर जाएं](#ai-thesis-fit)

टेम्पलेट्स में प्लेसहोल्डर

टेम्पलेट्स में हम उपयोग करते हैं:

  • [ ] — "भरें"
  • / — "— / लागू नहीं" (जब सार्थक हो)
  • YYYY‑MM‑DD — दिनांक प्रारूप
  • Tier‑1/2/3 — स्रोत स्तर (साक्ष्य/संदर्भ/शोर)

सामान्य गलतियाँ

  • इन्फोबॉक्स और विवरण को मिलाना: इन्फोबॉक्स केवल संक्षिप्त तथ्यों के लिए है; स्पष्टीकरण पृष्ठ के मुख्य भाग में जाते हैं।
  • जहाँ स्रोत मौजूद होना चाहिए वहाँ स्रोतों के बिना लिखना
  • "पहली स्क्रीन" को ओवरलोड करना: लंबे विवरण <details> के अंदर रखना बेहतर है।
  • "वित्तीय भाषा" का उपयोग करना (खरीदें/बेचें/होल्ड सलाह, पूर्वानुमान) — यह हमारे लिए निषिद्ध है; हम तथ्य/जोखिम/क्या सत्यापित करना है, लिखते हैं।

प्रकाशित करने से पहले मिनी चेकलिस्ट

  • क्या 1-2 पंक्तियाँ हैं जो बताती हैं कि "यह क्या है"?
  • क्या प्राथमिक स्रोतों के लिंक हैं?
  • क्या कोई खाली "अस्पष्ट" तालिका फ़ील्ड हैं (प्रत्येक या तो एक मान है या —/—)?
  • क्या Last verified (अंतिम सत्यापित) भरा गया है?