Markdown
बोलियाँ / जायके

टिप्पणियों

स्टैक ओवरफ्लो मार्कडाउन

यह मार्कडाउन का स्वाद है जो स्टैक ओवरफ्लो और अन्य स्टैक एक्सचेंज साइटों द्वारा उपयोग किया जाता है। जब आप किसी प्रश्न का उत्तर देते हैं या प्रलेखन जोड़ते हैं तो आप इस मार्कडाउन का उपयोग करते हैं। यह उत्तर SO मार्कडाउन से बना है

आधिकारिक दस्तावेज देखें

मुख्य चीजें जो एसओ मार्कडाउन जोड़ती हैं, उस वेबपेज पर "स्टैक एक्सचेंज एडिशन" के तहत हैं। विशेष रूप से, SO [tag:tag] और शॉर्टकट लिंक जैसे [meta] (हालांकि डॉक्स में नहीं), स्पॉइलर जैसे टैग जोड़ता है:

यह एक स्पॉइलर है

>! This is a spoiler

और कस्टम भाषा भक्ति

<!-- language: java -->
```
This text is formatted as if it were Java code
```

This text is formatted as if it were Java code

Doxygen Markdown

Doxygen एक आमतौर पर इस्तेमाल किया जाने वाला कोड प्रलेखन उपकरण है (C ++, C # और Java सहित भाषाओं के लिए) जो मार्कडाउन के उपयोग का समर्थन भी करता है। मानक मार्कडाउन सिंटैक्स के अलावा, इसमें कई डॉक्सिजन-विशिष्ट तत्व हैं ।

प्राथमिक विशेषताएं संदर्भों के लिए @ref टैग्स, और @section/@subsection @page , @section/@subsection और @anchor तत्वों का उपयोग हैं जिन्हें ये संदर्भित कर सकते हैं।

@ref <नाम> ["पाठ"]

यह तत्व एक नामित अनुभाग, उपधारा, पृष्ठ या लंगर के लिए एक लिंक (यानी संदर्भ) बनाता है जिसे प्रलेखन में कहीं और परिभाषित किया गया है। (देखें Doxygen का संदर्भ )

पहला पैरामीटर ( name ) उस अनुभाग, उपधारा, पृष्ठ या एंकर के नाम से मेल खाना चाहिए जिसे आप लिंक करना चाहते हैं।

दूसरे वैकल्पिक पैरामीटर ( "text" ) को दोहरे उद्धरणों में समझाया जाना चाहिए, और यह परिभाषित करेगा कि संदर्भ लिंक पृष्ठ पर क्या दिखाई देगा। यदि उपयोग नहीं किया जाता है, तो लिंक संदर्भ में उपयोग किए गए शीर्षक के रूप में दिखाई देगा।

@ स्नेह <अनुभाग-नाम> (अनुभाग शीर्षक)

यह तत्व एक अनुभाग नाम को परिभाषित करता है। यह मार्कडाउन में एक # तत्व के बराबर है, हालांकि यह एक संदर्भ को भी परिभाषित करेगा जो आपके प्रलेखन के अन्य वर्गों से जोड़ा जा सकता है। (देखें Doxygen का संदर्भ )

पहला पैरामीटर section-name संदर्भ section-name को परिभाषित करता है जिसका उपयोग @ref तत्व द्वारा किया जा सकता है। इसमें कोई स्थान नहीं हो सकता।

दूसरा पैरामीटर section title शब्दों का एक स्ट्रिंग है (जिसे रिक्त स्थान द्वारा अलग किया जा सकता है) जो परिभाषित करता है कि आपके पृष्ठ पर अनुभाग शीर्षक क्या दिखाई देगा।

उदाहरण

@section Intro Introduction

This is some text in my introduction.

@section Body Body Paragraph

This is some text in my body, where I refer to the @ref Intro.

उत्पादन

परिचय

यह मेरे परिचय का कुछ पाठ है।

मुख्य भाग अनुच्छेद

यह मेरे शरीर में कुछ पाठ है, जहां मैं परिचय का उल्लेख करता हूं।

NB: ऊपर दिया गया शब्द परिचय एक लिंक के रूप में दिखाई देगा जो कि परिचय शीर्षक पर जाएगा।

गिटहब फ्लेवर्ड मार्कडाउन

GitHub Flavoured Markdown (कभी-कभी GFM के लिए संक्षिप्त) GitHub.com पर मार्कडाउन के साथ काम करना आसान बनाता है।

GFM की प्रमुख विशेषताओं में शामिल हैं:

• कोड इंडेंटेशन
• कार्य सूची समर्थन
• आसान GitHub मुद्दा संदर्भित
• स्वचालित गिटहब उपयोगकर्ता नाम और SHA का पता लगाना
• स्वचालित url का पता लगाना
• इमोजी सपोर्ट करते हैं

GFM उदाहरण हैं

वाक्य - विन्यास पर प्रकाश डालना

मार्कडाउन के साथ, तीन बैकटिक्स के साथ कोड का एक ब्लॉक उत्पन्न किया जा सकता है:

```

सिंटैक्स हाइलाइटिंग के बिना, सी में लिखा कोड इस तरह दिखाई देता है

#include <stdio.h>

int main(void)
{
    printf("Hello World\n");
    return (0);
}

हालाँकि, सिंटैक्स हाइलाइटिंग के साथ , C में लिखा कोड इस तरह दिखाई देता है:

कोड को हाइलाइट करने के लिए, अपने फेंसेड कोड ब्लॉक में सिंटैक्स हाइलाइटिंग को सक्षम करने के लिए बस एक वैकल्पिक भाषा पहचानकर्ता जोड़ें।

```C
<code text here>
```

इन संवर्द्धन को README फाइलों में शामिल प्रलेखन और वार्तालाप की गुणवत्ता में सुधार करने के लिए डिज़ाइन किया गया है, मंच पर gist , pull अनुरोध और मुद्दे ।