Markdown कोड ब्लॉक्स गाइडः इनलाइन कोड, फेंस्ड ब्लॉक्स, और सिंटैक्स हाइलाइटिंग

कोड स्वरूपण Markdown की सबसे मजबूत विशेषताओं में से एक है। चाहे आप किसी फ़ंक्शन को दस्तावेज कर रहे हों, टर्मिनल कमांड दिखा रहे हों, या ट्यूटोरियल लिख रहे हों, मार्कडाउन कोड सिंटैक्स कोड को विजुअल रूप से अलग रखता है, सही ढंग से स्वरूपित, और (अधिकांश प्लेटफार्मों पर) वाक्यविन्यास-उल्लेखित। यह मार्गदर्शिका इस बारे में सब कुछ कवर करती है Markdown कोड ब्लॉक.

इनलाइन कोड

एक छोटे से स्निपेट या एकल अभिव्यक्ति को एकल बैकटिक्स में लपेटें:

Use `console.log()` to print output.
Set the variable with `const x = 42;`.
The file is saved as `README.md`.

इनलाइन कोड एक मोनोस्पेस फ़ॉन्ट में प्रस्तुत करता है, जो आसपास के पाठ से दृश्य रूप से अलग होता है। इसका प्रयोग:

• फ़ंक्शन और विधि के नाम: addEventListener()
• चर के नाम: isLoading
• फ़ाइल नाम: package.json
• आदेश तर्क: --verbose
• संक्षिप्त कोड अभिव्यक्ति

यदि आपके इनलाइन कोड में एक बैकटिक है, तो इसे लपेटने के लिए डबल बैकटिक्स का उपयोग करें:

`` `backtick inside` ``

वेन्स्ड कोड ब्लॉक

बहु-पंक्ति कोड के लिए, ब्लॉक को खोलने और बंद करने के लिए ट्रिपल बैकटिक्स (`) का उपयोग करेंः

```
This is a code block.
It preserves all whitespace and line breaks.
No formatting is applied inside.
```

अंतराल, अंतराल, और नई रेखाएं सभी सटीक रूप से संरक्षित हैं।

वाक्यविन्यास हाइलाइटिंग

वाक्यविन्यास हाइलाइटिंग को सक्षम करने के लिए खोलने वाले ट्रिपल बैकटिक के बाद एक भाषा पहचानकर्ता जोड़ें:

```python
def greet(name: str) -> str:
    return f"Hello, {name}!"

print(greet("World"))
```

```javascript
const greet = (name) => `Hello, ${name}!`;
console.log(greet("World"));
```

```bash
#!/bin/bash
echo "Hello, World!"
ls -la ~/Documents
```

सामान्य भाषा पहचानकर्ता

अंतर्निहित कोड ब्लॉक

एक पुराना Markdown वाक्यविन्यास कोड ब्लॉकों के लिए 4-स्पेस इंडेंटेशन का उपयोग करता हैः

    function oldStyle() {
        return "This is a code block";
    }

यह CommonMark संगत है लेकिन कम पठनीय है और भाषा पहचानकों का समर्थन नहीं करता है. इसके बजाय, बाड़ लगाए हुए ब्लॉक (ट्रिपल बैकस्टिक्स) का उपयोग करें।

Word दस्तावेज़ों से कोड परिवर्तित करना

Word (Courier New, Consolas, आदि) में मोनोस्पेस पाठ इनलाइन कोड में परिवर्तित होता है जब आप उपयोग करते हैं WordToMD. Multi-line code in Word converts depending on how it was formatted:

• मोनोस्पेस फ़ॉन्ट अनुच्छेद → कई इनलाइन कोड स्निपेट बन सकते हैं
• Word कोड शैली → कोड ब्लॉक में परिवर्तित करता है
• शाब्दिक पाठ ब्लॉक → मैन्युअल बाड़ लगाना पड़ सकता है

रूपांतरण के बाद, कोड अनुभागों की जाँच करें और यदि आवश्यक हो तो उचित बाड़ जोड़ेंः

1. वह कोड ढूंढें जो ब्लॉक होना चाहिए
2. इसे ट्रिपल बैकटीक्स से लपेटें
3. उपयुक्त भाषा पहचानकर्ता जोड़ें

भाषा-विशिष्ट उदाहरण

HTTP अनुरोध

```http
POST /api/users HTTP/1.1
Host: api.example.com
Content-Type: application/json
Authorization: Bearer TOKEN

{
  "name": "Alice",
  "email": "alice@example.com"
}
```

टर्मिनल कमांड

```bash
npm install
npm run build
npm run dev
```

डिफ आउटपुट

```diff
- const oldValue = "hello";
+ const newValue = "world";
  console.log(newValue);
```

YAML कॉन्फ़िगरेशन

```yaml
server:
  host: localhost
  port: 8080
  debug: true
database:
  url: postgresql://localhost:5432/mydb
```

नेस्टेड कोड ब्लॉक (प्रलेखन के लिए)

Markdown स्वयं को दस्तावेज करते समय, 3 बैकटिक्स वाले ब्लॉक को लपेटने के लिए 4 बैकटिक्स का उपयोग करें:

````markdown
```python
# This is a code block inside documentation
```
````

प्लेटफार्म समर्थन

पंक्ति संख्याएँ

मानक Markdown कोड ब्लॉक में पंक्ति संख्याओं का समर्थन नहीं करता है. कुछ प्लेटफार्मों और स्थैतिक साइट जनरेटर प्लगइन्स के माध्यम से इसे जोड़ते हैंः

• Prism.js (बहुत से एसएसजी द्वारा प्रयोग किया जाता है) add {numberLines: true} कोड बाड़ में
• GitHub Markdown में कोई देशी पंक्ति संख्या नहीं है (इसके बजाय GitHub दोष दृश्य का उपयोग करें)
• GitBook कोड ब्लॉक सेटिंग्स के माध्यम से पंक्ति संख्याएँ

ब्लॉक से कोड कॉपी करना

GitHub और कई प्लेटफ़ॉर्म कोड ब्लॉक में स्वचालित रूप से Copy बटन जोड़ते हैं. यह एक रेंडरिंग वृद्धि है इसे आपके Markdown में कुछ विशेष की आवश्यकता नहीं है.

FAQ

मेरा कोड ब्लॉक वाक्यविन्यास क्यों हाइलाइट नहीं किया गया है? या तो भाषा पहचानकर्ता गायब है या गलत वर्तनी है, या प्लेटफ़ॉर्म विशिष्ट भाषा का समर्थन नहीं करता है। उपरोक्त पहचानकर्ता सूची की जाँच करें।

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

मेरे Word दस्तावेज़ में रंगीन वाक्यविन्यास-उल्लेखित कोड था. क्या WordToMD रंगों को संरक्षित रखेगा? कोई Markdown कोड ब्लॉक रंग स्वरूपण को संरक्षित नहीं करते हैं. WordToMD पाठ को कोड ब्लॉक में परिवर्तित करता है; तब भाषा पहचानकर्ता के आधार पर Markdown रेंडरर द्वारा वाक्यविन्यास हाइलाइटिंग लागू की जाती है।

क्या मैं कोड ब्लॉक के भीतर विशिष्ट पंक्तियों को हाइलाइट कर सकता हूँ? मानक Markdown इसका समर्थन नहीं करता है. कुछ प्लेटफार्मों (जैसे एस्ट्रो शिकी के साथ, या ह्यूगो) ने टिप्पणियों के माध्यम से रेखा को उजागर कियाः {1,3-5} भाषा पहचानकर्ता के बाद।

संबंधित मार्गदर्शिकाएँ

• __पी_बी__ वाक्यविन्यास __पी_ए__ पूर्ण संदर्भ
• Word से API दस्तावेज कोड-भारी प्रलेखन
• __पी_सी__ से __पी_बी__ __पी_ए__ GitHub-विशिष्ट कोड स्वरूपण

निष्कर्ष

मार्कडाउन कोड ब्लॉक सरल हैं: इनलाइन कोड के लिए बैकटिक्स, ब्लॉक के लिए भाषा पहचानकर्ता के साथ ट्रिपल बैकटिक्स। Word के साथ दस्तावेज़ परिवर्तित करने के बाद WordToMD, यह जांचें कि कोड वाक्यविन्यास में मोनोस्पेस पाठ सही ढंग से लपेटा गया है, और अपने लक्षित प्लेटफॉर्म पर उचित वाक्यविन्यास हाइलाइटिंग के लिए भाषा पहचानकर्ता जोड़ें।