सिंटैक्स संदर्भ

मार्कडाउन सिंटैक्स: वे पैटर्न जिनका आप सबसे अधिक उपयोग करेंगे

आप पैटर्न के एक छोटे से समूह के साथ उपयोगी मार्कडाउन लिख सकते हैं। सिमेंटिक संरचना से शुरू करें, ब्लॉक एलिमेंट्स के आस-पास खाली पंक्तियाँ छोड़ें, और दस्तावेज़ को उस रेंडरर में पूर्वावलोकन करें जहाँ इसे प्रकाशित किया जाएगा।

8 मिनट का पठन

शीर्षक और पैराग्राफ

किसी शीर्षक के पहले एक से छह हैश वर्ण लगाएँ। दस्तावेज़ शीर्षक के लिए एक H1 का उपयोग करें, फिर केवल दृश्य आकार के लिए शीर्षक चुनने के बजाय स्तरों में नीचे उतरें। पैराग्राफ खाली पंक्ति से अलग होते हैं।

शीर्षकMarkdown
# Document title

An opening paragraph.

## Installation

Setup details.

### Environment variables

Configuration details.

ज़ोर, लिंक और इमेज

ज़ोर के लिए तारांकन, दिखाई देने वाले लिंक टेक्स्ट के लिए वर्गाकार कोष्ठक और गंतव्य के लिए कोष्ठक का उपयोग करें। इमेज सिंटैक्स में विस्मयादिबोधक चिह्न जुड़ता है; जब इमेज नहीं देखी जा सकती तो सार्थक वैकल्पिक टेक्स्ट महत्वपूर्ण रहता है।

इनलाइन सिंटैक्सMarkdown
Use **bold** for strong importance and *italic* for emphasis.

Read the [deployment guide](/guides/deploy).

![A diagram of the request flow](request-flow.png)

सूचियाँ और टास्क लिस्ट

अक्रमित आइटम को हाइफ़न से और क्रमित आइटम को संख्या से शुरू करें। नेस्टेड आइटम को लगातार इंडेंट करें। कई डेवलपर प्लेटफ़ॉर्म GitHub Flavored Markdown के माध्यम से टास्क-लिस्ट चेकबॉक्स का भी समर्थन करते हैं।

सूचियाँMarkdown
- Prepare the release
  - Update the changelog
  - Freeze migrations
- Deploy

1. Start the canary
2. Watch metrics
3. Expand traffic

- [x] Tests pass
- [ ] Docs reviewed

इनलाइन कोड और फ़ेंस्ड कोड ब्लॉक

छोटे पहचानकर्ता या कमांड को एकल बैकटिक्स में लपेटें। लंबे उदाहरणों को ट्रिपल-बैकटिक फ़ेंस के बीच रखें और जब रेंडरर सिंटैक्स हाइलाइटिंग का समर्थन करता है तो भाषा का नाम जोड़ें। निष्पादन योग्य उदाहरणों को समझने और परीक्षण करने लायक पूर्ण रखें।

कोडMarkdown
Set `SERVICE_URL` in the server environment.

```ts
type Result = {
  markdown: string;
  fileName: string;
};
```

ब्लॉककोट, नियम और टेबल

ब्लॉककोट उद्धृत सामग्री या छोटे कॉलआउट के लिए उपयोगी होते हैं। क्षैतिज रेखाएँ बड़े संक्रमणों को अलग करती हैं। टेबल कॉम्पैक्ट, आयताकार डेटा के लिए काम करती हैं; जब कोशिकाओं में लंबा गद्य हो या टेबल बहुत चौड़ी हो तो वे पढ़ने में कठिन हो जाती हैं।

GFM टेबलMarkdown
> Conversion preserves structure, not pixel-perfect layout.

---

| Format | Good for | Review |
| --- | --- | --- |
| DOCX | Styled prose | Tables |
| CSV | Small datasets | Escaping |

ऐसा सिंटैक्स लिखें जो अलग-अलग रेंडरर में टिके

शीर्षकों, सूचियों, टेबल और फ़ेंस्ड कोड ब्लॉक के आस-पास खाली पंक्तियाँ छोड़ें। नंगे URL के बजाय वर्णनात्मक लिंक चुनें। रॉ HTML से बचें जब तक कि प्रकाशन प्रणाली स्पष्ट रूप से उसका समर्थन और सैनिटाइज़ेशन न करे। जब कोई सुविधा प्लेटफ़ॉर्म-विशिष्ट हो, तो पर्याप्त सादा टेक्स्ट शामिल करें ताकि दस्तावेज़ कहीं और भी सार्थक बना रहे।

एक पूर्वावलोकन बताता है कि दस्तावेज़ यहाँ कैसे रेंडर होता है; आपकी लक्षित रिपॉज़िटरी या डॉक्यूमेंटेशन प्रणाली ही अंतिम संगतता परीक्षण बनी रहती है।

लाइव पूर्वावलोकन के साथ सिंटैक्स का अभ्यास करें

एक स्थानीय ड्राफ़्ट खोलें और टाइप करते ही शीर्षक, सूचियाँ, कोड और टेबल रेंडर होते देखें।

एडिटर आज़माएँ