Markdown कोड सिंटैक्स

कोड तकनीकी दस्तावेज़ीकरण का एक महत्वपूर्ण तत्व है। Markdown कोड प्रदर्शित करने के कई तरीके प्रदान करता है, जिसमें इनलाइन कोड और कोड ब्लॉक शामिल हैं।

Markdown इनलाइन कोड

Markdown बुनियादी सिंटैक्स

बैकटिक ` का उपयोग करके कोड लपेटें:

markdown

यह `इनलाइन कोड` का एक उदाहरण है।
`console.log()` फंक्शन का उपयोग करके जानकारी आउटपुट करें।

रेंडर किया गया आउटपुट:

यह इनलाइन कोड का एक उदाहरण है। console.log() फंक्शन का उपयोग करके जानकारी आउटपुट करें।

बैकटिक युक्त Markdown कोड

जब कोड स्वयं बैकटिक शामिल करता है, तो डबल बैकटिक का उपयोग करें:

markdown

``Use `console.log()` function``

रेंडर किया गया आउटपुट:

Use `console.log()` function

कई बैकटिक हैंडलिंग

markdown

```कोड जिसमें कई बैकटिक `` ` ``` यहाँ`` `

रेंडर किया गया आउटपुट:

कोड जिसमें कई बैकटिक `` ` यहाँ`` `

Markdown कोड ब्लॉक

Markdown इंडेंटेड कोड ब्लॉक

4 स्थान या 1 टैब इंडेंट करें:

markdown

    function hello() {
        console.log("Hello, World!");
    }

रेंडर किया गया आउटपुट:

function hello() {
    console.log("Hello, World!");
}

Markdown फेंस्ड कोड ब्लॉक

तीन बैकटिक ``` या टिल्ड ~~~ का उपयोग करके कोड लपेटें:

markdown

```
function hello() {
    console.log("Hello, World!");
}
```

रेंडर किया गया आउटपुट:

function hello() {
    console.log("Hello, World!");
}

प्रोग्रामिंग भाषा निर्दिष्ट करना

सिंटैक्स हाइलाइटिंग सक्षम करने के लिए खोलने वाले ``` के बाद भाषा नाम निर्दिष्ट करें:

markdown

```javascript
function hello(name) {
    console.log(`Hello, ${name}!`);
}
```

रेंडर किया गया आउटपुट:

javascript

function hello(name) {
    console.log(`Hello, ${name}!`);
}

सामान्य प्रोग्रामिंग भाषा उदाहरण

JavaScript

markdown

```javascript
// एक async फंक्शन का उदाहरण
async function fetchData(url) {
    try {
        const response = await fetch(url);
        const data = await response.json();
        return data;
    } catch (error) {
        console.error('त्रुटि:', error);
    }
}
```

रेंडर किया गया आउटपुट:

javascript

// एक async फंक्शन का उदाहरण
async function fetchData(url) {
    try {
        const response = await fetch(url);
        const data = await response.json();
        return data;
    } catch (error) {
        console.error('त्रुटि:', error);
    }
}

Python

markdown

```python
# एक क्लास परिभाषा का उदाहरण
class Calculator:
    def __init__(self):
        self.result = 0
    
    def add(self, x, y):
        return x + y
    
    def multiply(self, x, y):
        return x * y

# उपयोग उदाहरण
calc = Calculator()
print(calc.add(5, 3))
```

रेंडर किया गया आउटपुट:

python

# एक क्लास परिभाषा का उदाहरण
class Calculator:
    def __init__(self):
        self.result = 0
    
    def add(self, x, y):
        return x + y
    
    def multiply(self, x, y):
        return x * y

# उपयोग उदाहरण
calc = Calculator()
print(calc.add(5, 3))

HTML

markdown

```html
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>नमूना पेज</title>
</head>
<body>
    <h1>Markdown में स्वागत है</h1>
    <p>यह एक नमूना पैराग्राफ है।</p>
</body>
</html>
```

रेंडर किया गया आउटपुट:

html

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>नमूना पेज</title>
</head>
<body>
    <h1>Markdown में स्वागत है</h1>
    <p>यह एक नमूना पैराग्राफ है।</p>
</body>
</html>

CSS

markdown

```css
/* उत्तरदायी लेआउट उदाहरण */
.container {
    max-width: 1200px;
    margin: 0 auto;
    padding: 0 20px;
}

@media (max-width: 768px) {
    .container {
        padding: 0 10px;
    }
}

.button {
    background-color: #007bff;
    color: white;
    border: none;
    padding: 10px 20px;
    border-radius: 4px;
    cursor: pointer;
}

.button:hover {
    background-color: #0056b3;
}
```

रेंडर किया गया आउटपुट:

css

/* उत्तरदायी लेआउट उदाहरण */
.container {
    max-width: 1200px;
    margin: 0 auto;
    padding: 0 20px;
}

@media (max-width: 768px) {
    .container {
        padding: 0 10px;
    }
}

.button {
    background-color: #007bff;
    color: white;
    border: none;
    padding: 10px 20px;
    border-radius: 4px;
    cursor: pointer;
}

.button:hover {
    background-color: #0056b3;
}

Bash/Shell

markdown

```bash
#!/bin/bash

# फ़ाइलों को बैच प्रोसेस करने का स्क्रिप्ट उदाहरण
for file in *.txt; do
    if [ -f "$file" ]; then
        echo "प्रोसेसिंग $file"
        cp "$file" "backup_$file"
    fi
done

# फंक्शन परिभाषा
function check_dependencies() {
    command -v git >/dev/null 2>&1 || {
        echo "Git आवश्यक है लेकिन स्थापित नहीं है।"
        exit 1
    }
}

check_dependencies
echo "सभी निर्भरताएँ संतुष्ट हैं।"
```

रेंडर किया गया आउटपुट:

bash

#!/bin/bash

# फ़ाइलों को बैच प्रोसेस करने का स्क्रिप्ट उदाहरण
for file in *.txt; do
    if [ -f "$file" ]; then
        echo "प्रोसेसिंग $file"
        cp "$file" "backup_$file"
    fi
done

# फंक्शन परिभाषा
function check_dependencies() {
    command -v git >/dev/null 2>&1 || {
        echo "Git आवश्यक है लेकिन स्थापित नहीं है।"
        exit 1
    }
}

check_dependencies
echo "सभी निर्भरताएँ संतुष्ट हैं।"

JSON

markdown

```json
{
  "name": "markdown-tutorial",
  "version": "1.0.0",
  "description": "Markdown हिंदी ट्यूटोरियल",
  "main": "index.js",
  "scripts": {
    "dev": "vitepress dev docs",
    "build": "vitepress build docs",
    "preview": "vitepress preview docs"
  },
  "dependencies": {
    "vitepress": "^1.0.0"
  },
  "author": "आपका नाम",
  "license": "MIT"
}
```

रेंडर किया गया आउटपुट:

json

{
  "name": "markdown-tutorial",
  "version": "1.0.0",
  "description": "Markdown हिंदी ट्यूटोरियल",
  "main": "index.js",
  "scripts": {
    "dev": "vitepress dev docs",
    "build": "vitepress build docs",
    "preview": "vitepress preview docs"
  },
  "dependencies": {
    "vitepress": "^1.0.0"
  },
  "author": "आपका नाम",
  "license": "MIT"
}

उन्नत कोड ब्लॉक सुविधाएँ

लाइन नंबर दिखाना

कुछ Markdown प्रोसेसर लाइन नंबर दिखाने का समर्थन करते हैं:

markdown

```javascript {1}
```
// यह पहली पंक्ति है
function example() {
    console.log("हैलो");
}
```

लाइन हाइलाइटिंग

विशिष्ट पंक्तियों को हाइलाइट करें:

markdown

```javascript {2-3}
function example() {
    console.log("यह पंक्ति हाइलाइट की गई");  // हाइलाइट किया गया
    return true;               // हाइलाइट किया गया
}
```

फ़ाइलनाम दिखाना

कोड फ़ाइलनाम प्रदर्शित करें:

markdown

```javascript title="app.js"
const express = require('express');
const app = express();

app.get('/', (req, res) => {
    res.send('Hello World!');
});
```

सामान्य त्रुटियाँ और समाधान

1. बैकटिक की असंगत संख्या

markdown

❌ गलत:
```javascript
function hello() {
    console.log("हैलो");
}
``  ← बैकटिक की असंगत संख्या

✅ सही:
```javascript
function hello() {
    console.log("हैलो");
}
```

2. असंगत इंडेंटेशन

markdown

❌ गलत: इंडेंटेड कोड ब्लॉक
    पहली पंक्ति (4 स्थान)
  दूसरी पंक्ति (2 स्थान)  ← असंगत इंडेंटेशन

✅ सही: इंडेंटेड कोड ब्लॉक
    पहली पंक्ति (4 स्थान)
    दूसरी पंक्ति (4 स्थान)

3. गलत भाषा नाम

markdown

❌ गलत:
```js  ← javascript होना चाहिए
function hello() {}
```

✅ सही:
```javascript
function hello() {}
```

function hello() {}

✅ सही:

markdown

```javascript
function hello() {}
```

javascript

function hello() {}

समर्थित भाषा सूची

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

भाषा	पहचानकर्ता	उदाहरण
JavaScript	`javascript`, `js`	`function(){}`
Python	`python`, `py`	`def function():`
Java	`java`	`public class{}`
C++	`cpp`, `c++`	`#include <iostream>`
C#	`csharp`, `cs`	`public class{}`
Go	`go`	`func main(){}`
Rust	`rust`, `rs`	`fn main(){}`
TypeScript	`typescript`, `ts`	`interface{}`
PHP	`php`	`<?php`
Ruby	`ruby`, `rb`	`def method`
SQL	`sql`	`SELECT * FROM`
HTML	`html`	`<div></div>`
CSS	`css`	`.class{}`
XML	`xml`	`<root></root>`
YAML	`yaml`, `yml`	`key: value`
Markdown	`markdown`, `md`	`# Title`
Bash	`bash`, `sh`	`#!/bin/bash`
PowerShell	`powershell`, `ps1`	`Get-Process`
Dockerfile	`dockerfile`	`FROM ubuntu`

सर्वोत्तम प्रथाएं

1. उपयुक्त कोड प्रारूप चुनें

markdown

✅ अनुशंसित: छोटे कोड के लिए इनलाइन प्रारूप का उपयोग करें
`Array.map()` विधि का उपयोग करके सरणियों को प्रोसेस करें।

✅ अनुशंसित: लंबे कोड के लिए कोड ब्लॉक का उपयोग करें
function processArray(arr) {
    return arr.map(item => item * 2);
}

2. उचित टिप्पणियाँ जोड़ें

markdown

✅ अनुशंसित: स्पष्टीकरण टिप्पणियाँ शामिल करें
```javascript
// सरणी तत्वों का औसत निकालें
function calculateAverage(numbers) {
    const sum = numbers.reduce((acc, num) => acc + num, 0);
    return sum / numbers.length;
}
```

3. सही भाषा पहचानकर्ता का उपयोग करें

markdown

✅ अनुशंसित: स्पष्ट भाषा पहचानकर्ता
```typescript
interface User {
    id: number;
    name: string;
}
```

❌ अनुशंसित नहीं: अस्पष्ट भाषा पहचानकर्ता
```text
interface User {
    id: number;
    name: string;
}
```

4. कोड को संक्षिप्त रखें

markdown

✅ अनुशंसित: कोर तर्क दिखाएँ
```javascript
// उपयोगकर्ता प्रमाणीकरण
function authenticate(token) {
    return validateToken(token);
}
```

❌ अनुशंसित नहीं: बहुत अधिक अप्रासंगिक विवरण
```javascript
// यह एक लंबा कोड है जिसमें बहुत सारे अप्रासंगिक विवरण हैं...
```

HTML आउटपुट

Markdown कोड HTML में परिवर्तित हो जाता है:

markdown

`इनलाइन कोड`

परिवर्तित हो जाता है:

html

<code>इनलाइन कोड</code>

कोड ब्लॉक:

markdown

```javascript
function hello() {}
```

परिवर्तित हो जाता है:

html

<pre><code class="language-javascript">
function hello() {}
</code></pre>

व्यावहारिक उदाहरण

API दस्तावेज़ीकरण

markdown

## उपयोगकर्ता लॉगिन

`/api/login` पर POST अनुरोध भेजें:

```bash
curl -X POST https://api.example.com/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "password": "password123"
  }'
```

नमूना प्रतिक्रिया:

```json
{
  "success": true,
  "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "user": {
    "id": 1,
    "email": "user@example.com",
    "name": "झांग सान"
  }
}
```

कॉन्फ़िगरेशन फ़ाइल उदाहरण

markdown

## परियोजना कॉन्फ़िगरेशन

एक `config.json` फ़ाइल बनाएँ:

```json
{
  "database": {
    "host": "localhost",
    "port": 5432,
    "name": "myapp"
  },
  "server": {
    "port": 3000,
    "host": "0.0.0.0"
  }
}
```

`package.json` स्क्रिप्ट अपडेट करें:

```json
{
  "scripts": {
    "start": "node server.js",
    "dev": "nodemon server.js",
    "test": "jest"
  }
}
```

स्थापना गाइड

markdown

## पर्यावरण सेटअप

अपने विकास पर्यावरण को कॉन्फ़िगर करने के लिए इन चरणों का पालन करें:

1. Node.js स्थापित करें:

```bash
# macOS (Homebrew का उपयोग करके)
brew install node

# Ubuntu/Debian
sudo apt update
sudo apt install nodejs npm

# Windows (Chocolatey का उपयोग करके)
choco install nodejs
```

2. स्थापना सत्यापित करें:

```bash
node --version
npm --version
```

3. परियोजना प्रारंभ करें:

```bash
mkdir my-project
cd my-project
npm init -y
```

अभ्यास

निम्नलिखित बनाने का प्रयास करें:

विभिन्न प्रोग्रामिंग भाषाओं में कोड उदाहरणों का संग्रह
अनुरोध और प्रतिक्रिया कोड के साथ API उपयोग ट्यूटोरियल
विभिन्न सिस्टम के लिए कमांड-लाइन निर्देशों के साथ स्थापना गाइड
विस्तृत टिप्पणियों के साथ एक कॉन्फ़िगरेशन फ़ाइल टेम्पलेट

Markdown कोड सिंटैक्स ​

Markdown इनलाइन कोड ​

Markdown बुनियादी सिंटैक्स ​

बैकटिक युक्त Markdown कोड ​

कई बैकटिक हैंडलिंग ​

Markdown कोड ब्लॉक ​

Markdown इंडेंटेड कोड ब्लॉक ​

Markdown फेंस्ड कोड ब्लॉक ​

प्रोग्रामिंग भाषा निर्दिष्ट करना ​

सामान्य प्रोग्रामिंग भाषा उदाहरण ​

JavaScript ​

Python ​

HTML ​

CSS ​

Bash/Shell ​

JSON ​

उन्नत कोड ब्लॉक सुविधाएँ ​

लाइन नंबर दिखाना ​

लाइन हाइलाइटिंग ​

फ़ाइलनाम दिखाना ​

सामान्य त्रुटियाँ और समाधान ​

1. बैकटिक की असंगत संख्या ​

2. असंगत इंडेंटेशन ​

3. गलत भाषा नाम ​

समर्थित भाषा सूची ​

सर्वोत्तम प्रथाएं ​

1. उपयुक्त कोड प्रारूप चुनें ​

2. उचित टिप्पणियाँ जोड़ें ​

3. सही भाषा पहचानकर्ता का उपयोग करें ​

4. कोड को संक्षिप्त रखें ​

HTML आउटपुट ​

व्यावहारिक उदाहरण ​

API दस्तावेज़ीकरण ​

कॉन्फ़िगरेशन फ़ाइल उदाहरण ​

स्थापना गाइड ​

संबंधित सिंटैक्स ​

अभ्यास ​

Markdown कोड सिंटैक्स

Markdown इनलाइन कोड

Markdown बुनियादी सिंटैक्स

बैकटिक युक्त Markdown कोड

कई बैकटिक हैंडलिंग

Markdown कोड ब्लॉक

Markdown इंडेंटेड कोड ब्लॉक

Markdown फेंस्ड कोड ब्लॉक

प्रोग्रामिंग भाषा निर्दिष्ट करना

सामान्य प्रोग्रामिंग भाषा उदाहरण

JavaScript

Python

HTML

CSS

Bash/Shell

JSON

उन्नत कोड ब्लॉक सुविधाएँ

लाइन नंबर दिखाना

लाइन हाइलाइटिंग

फ़ाइलनाम दिखाना

सामान्य त्रुटियाँ और समाधान

1. बैकटिक की असंगत संख्या

2. असंगत इंडेंटेशन

3. गलत भाषा नाम

समर्थित भाषा सूची

सर्वोत्तम प्रथाएं

1. उपयुक्त कोड प्रारूप चुनें

2. उचित टिप्पणियाँ जोड़ें

3. सही भाषा पहचानकर्ता का उपयोग करें

4. कोड को संक्षिप्त रखें

HTML आउटपुट

व्यावहारिक उदाहरण

API दस्तावेज़ीकरण

कॉन्फ़िगरेशन फ़ाइल उदाहरण

स्थापना गाइड

संबंधित सिंटैक्स

अभ्यास