शीर्षक ID

शीर्षक ID Markdown की एक विस्तार सुविधा है जो शीर्षकों को कस्टम पहचानकर्ता जोड़ने की अनुमति देती है, जो सटीक लिंक बनाने और दस्तावेज़ संरचना पर नियंत्रण को सुगम बनाती है।

मूल सिंटैक्स

शीर्षक ID जोड़ना

शीर्षक ID ब्रेस सिंटैक्स का उपयोग करता है, जो शीर्षक टेक्स्ट के बाद रखा जाता है:

## मेरा शीर्षक {#custom-id}

रेंडरिंग प्रभाव:

HTML आउटपुट में इस कस्टम ID को शीर्षक तत्व में जोड़ा जाएगा:

<h2 id="custom-id">मेरा शीर्षक</h2>

बहु-स्तरीय शीर्षक ID

सभी स्तरों के शीर्षक कस्टम ID जोड़ सकते हैं:

# प्रथम स्तर शीर्षक {#first-level}

## द्वितीय स्तर शीर्षक {#second-level}

### तृतीय स्तर शीर्षक {#third-level}

#### चतुर्थ स्तर शीर्षक {#fourth-level}

अनुप्रयोग परिदृश्य

एंकर लिंक बनाना

कस्टम ID के साथ, आप दस्तावेज़ के भीतर विशिष्ट भागों को इंगित करने वाले लिंक बना सकते हैं:

[मेरे शीर्षक पर कूदने के लिए क्लिक करें](#custom-id)

...अन्य सामग्री...

## मेरा शीर्षक {#custom-id}

रेंडरिंग प्रभाव:

लिंक पर क्लिक करने से custom-id वाले शीर्षक पर सीधे कूद जाएगा।

बाहरी दस्तावेज़ों से दस्तावेज़ के विशिष्ट अनुभागों को लिंक करना

कस्टम ID बाहरी दस्तावेज़ों से विशिष्ट सामग्री को लिंक करने को भी सुगम बनाते हैं:

[अन्य दस्तावेज़ के विशिष्ट अनुभाग पर लिंक](other-doc.html#specific-section)

URL के माध्यम से विशिष्ट अनुभाग साझा करना

ID वाले शीर्षक URL के माध्यम से दूसरों के साथ साझा किए जा सकते हैं, जो दस्तावेज़ के विशिष्ट अनुभागों को इंगित करते हैं:

https://www.markdownlang.com/documentation.html#installation-guide

उन्नत उपयोग

बहु-शब्द शीर्षक ID

जब शीर्षक कई शब्दों वाले होते हैं, तो शीर्षक ID आमतौर पर हाइफन का उपयोग करके उन्हें जोड़ते हैं:

## स्थापना और कॉन्फ़िगरेशन गाइड {#installation-and-configuration}

सामग्री तालिका उत्पन्न करना और शीर्षक ID

कई Markdown प्रोसेसर शीर्षक सामग्री के आधार पर ID स्वचालित रूप से उत्पन्न करते हैं। कस्टम ID के माध्यम से, आप सुनिश्चित कर सकते हैं कि सामग्री तालिका लिंक शीर्षक सामग्री में परिवर्तनों से प्रभावित न हों:

## शुरुआत गाइड {#getting-started}

यदि आप बाद में शीर्षक को "शुरुआत" में बदलते हैं, तो लिंक वैध रहता है क्योंकि ID समान रहता है।

अंतरराष्ट्रीयकरण और गैर-अंग्रेजी वर्ण

गैर-अंग्रेजी शीर्षकों के लिए, कस्टम ID विशेष रूप से उपयोगी होते हैं क्योंकि वे स्थिर अंग्रेजी पहचानकर्ता प्रदान करते हैं:

## स्थापना निर्देश {#installation}

## उपयोग गाइड {#usage}

## अक्सर पूछे जाने वाले प्रश्न {#faq}

संगतता और कार्यान्वयन अंतर

विभिन्न प्लेटफॉर्मों पर समर्थन स्थिति

Platform/Tool	शीर्षक ID समर्थन	सिंटैक्स
GitHub Markdown	✅	{#id}
GitLab Markdown	✅	{#id}
Jekyll (kramdown)	✅	{:#id} or {#id}
Hugo	✅	{#id}
CommonMark	❌	समर्थित नहीं
VitePress	✅	{#id}
Pandoc	✅	{#id}

स्वचालित ID उत्पन्न करने के नियम

जब कस्टम ID प्रदान नहीं किया जाता, तो अधिकांश Markdown प्रोसेसर शीर्षक टेक्स्ट से ID स्वचालित रूप से उत्पन्न करते हैं:

1. छोटे अक्षरों में परिवर्तित करें
2. विशेष वर्णों को हटाएँ या बदलें
3. स्पेस को हाइफन से बदलें
4. डुप्लिकेट हाइफन हटाएँ
5. ID अद्वितीयता सुनिश्चित करें (आमतौर पर संख्यात्मक प्रत्यय जोड़कर)

उदाहरण के लिए:

शीर्षक	स्वचालित रूप से उत्पन्न ID
## Getting Started	#getting-started
## FAQ & Help	#faq-help
## Quick Start	#quick-start or #section-1 (प्लेटफॉर्म के अनुसार भिन्न)

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

शीर्षक ID नामकरण सम्मेलन

✅ अनुशंसित प्रथाएँ:

1. **संक्षिप्त वर्णनात्मक ID का उपयोग करें**:
   - `{#installation}`
   - `{#api-reference}`
   - `{#troubleshooting}`

2. **संगत नामकरण शैली बनाए रखें**:
   - सभी छोटे अक्षर
   - शब्दों को अलग करने के लिए हाइफन का उपयोग करें
   - अंडरस्कोर या camelCase से बचें

3. **ID स्थिरता बनाए रखें**:
   - ID में लगातार परिवर्तन से बचें
   - शीर्षक टेक्स्ट संशोधित करते समय मूल ID को संरक्षित करें

❌ बचने योग्य प्रथाएँ:

1. विशेष वर्णों का उपयोग (जैसे `!@#$%^&*()`)
2. गैर-वर्णनात्मक ID का उपयोग (जैसे `{#section1}`)
3. अत्यधिक लंबे ID बनाना
4. स्पेस या विराम चिह्नों का उपयोग

दस्तावेज़ संरचना और शीर्षक ID

बड़े दस्तावेज़ों के लिए, मुख्य अध्यायों के लिए मानकीकृत ID का उपयोग नेविगेशन को सुगम बनाने के लिए अनुशंसित है:

# उत्पाद दस्तावेज़ीकरण {#product-docs}

## परिचय {#introduction}

## स्थापना {#installation}

### Windows स्थापना {#installation-windows}

### macOS स्थापना {#installation-macos}

### Linux स्थापना {#installation-linux}

## कॉन्फ़िगरेशन {#configuration}

## API संदर्भ {#api-reference}

## FAQ {#faq}

व्यावहारिक अनुप्रयोग उदाहरण

तकनीकी दस्तावेज़ीकरण में शीर्षक ID

तकनीकी दस्तावेज़ीकरण में शीर्षक ID उपयोगकर्ताओं को विशिष्ट अनुभागों को सीधे लिंक करने में मदद कर सकते हैं:

# API दस्तावेज़ीकरण {#api-documentation}

## प्रमाणीकरण {#authentication}

### API कुंजी प्राप्त करना {#get-api-key}

### OAuth प्रमाणीकरण {#oauth}

## एंडपॉइंट {#endpoints}

### उपयोगकर्ता एंडपॉइंट {#endpoints-users}

### उत्पाद एंडपॉइंट {#endpoints-products}

शैक्षणिक पत्रों में शीर्षक ID

शैक्षणिक पत्र शीर्षक ID का उपयोग उद्धरण और क्रॉस-रेफरेंस बनाने के लिए कर सकते हैं:

# अनुसंधान पद्धति {#methodology}

जैसा कि [अनुसंधान परिणामों](#results) में दिखाया गया है, हमारी विधि कई परीक्षण मामलों में अच्छा प्रदर्शन करती है।

...

# अनुसंधान परिणाम {#results}

यह अनुभाग हमारी [अनुसंधान पद्धति](#methodology) में वर्णित प्रयोगात्मक परिणाम प्रस्तुत करता है।

सामान्य समस्या समाधान

शीर्षक ID काम नहीं कर रहे

यदि आपके शीर्षक ID काम नहीं कर रहे:

1. जांचें कि क्या प्लेटफॉर्म कस्टम शीर्षक ID का समर्थन करता है
2. पुष्टि करें कि सिंटैक्स सही है (आमतौर पर {#id})
3. सत्यापित करें कि ID में अमान्य वर्ण नहीं हैं
4. विभिन्न Markdown प्रोसेसर का प्रयास करें

ID संघर्ष

यदि एक ही दस्तावेज़ में कई समान ID हैं, तो यह अप्रत्याशित लिंकिंग व्यवहार का कारण बन सकता है:

## समस्या {#issue} <!-- पहला ID -->

...

## सामान्य समस्याएँ {#issue} <!-- डुप्लिकेट ID, समस्याएँ पैदा कर सकता है -->

ID संघर्ष से बचने का समाधान:

## समस्या {#issue-description}

...

## सामान्य समस्याएँ {#common-issues}

स्पेस और विशेष वर्ण

कुछ Markdown प्रोसेसर ID में स्पेस और विशेष वर्णों को असंगत रूप से संभालते हैं:

<!-- कुछ प्लेटफॉर्मों पर समस्याएँ हो सकती हैं -->
## उन्नत सेटिंग्स {#advanced settings}

<!-- सुरक्षित दृष्टिकोण -->
## उन्नत सेटिंग्स {#advanced-settings}

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

• लिंक - मूल लिंक सिंटैक्स
• सामग्री तालिका - स्वचालित रूप से उत्पन्न सामग्री तालिका
• फुटनोट - संदर्भ और स्पष्टीकरण जोड़ना

टूल और प्लगइन

स्वचालित रूप से उत्पन्न सामग्री तालिका

कई टूल शीर्षकों और शीर्षक ID के आधार पर सामग्री तालिका स्वचालित रूप से उत्पन्न कर सकते हैं:

[[toc]]

# अध्याय 1 {#chapter-1}

## अनुभाग 1.1 {#section-1-1}

# अध्याय 2 {#chapter-2}

शीर्षक ID जाँच टूल

• markdownlint: शीर्षक ID संगतता की जाँच के लिए कॉन्फ़िगर किया जा सकता है
• remark-lint: शीर्षक ID जाँच और ऑटो-फिक्स प्रदान करता है
• markdown-toc: लिंक के साथ सामग्री तालिका स्वचालित रूप से उत्पन्न करता है

---

शीर्षक ID Markdown दस्तावेज़ों की उपयोगिता और पहुंच को सुधारने के लिए एक महत्वपूर्ण टूल हैं। मानकीकृत शीर्षक ID का उपयोग करके, आप स्थिर लिंक संरचनाएँ बना सकते हैं जो नेविगेशन और संदर्भण को सुगम बनाती हैं, आपके दस्तावेज़ों को अधिक पेशेवर और उपयोगकर्ता-अनुकूल बनाती हैं।