Github पर एक "मार्कडाउन-स्वरूपित" README फ़ाइल क्या है?

27

यह मेरे लिए स्पष्ट नहीं है कि प्रारूप क्या है, अगर इसे बनाने के लिए व्यवस्थित / कमांड-लाइन आवश्यकताएं हैं, आदि।

असल में, बस चश्मे को जानने की जरूरत है, और अगर README फाइल बनाने के लिए तकनीकी कदम हैं।

github

— भूलों
स्रोत

4

नहीं, बस एक पाठ फ़ाइल जिसे आप हाथ से संपादित करते हैं। वाक्य रचना के लिए, en.wikipedia.org/wiki/Markdown

— एंड्रिया

3

इसका वही विकि-एडिट-प्रारूप है जिसका उपयोग यह पक्ष करता है।

— k3b

+1 @Andrea: धन्यवाद, हालांकि मैं एक मुट्ठी भर से अधिक मार्केड फॉर्मेट के बारे में सोच पा रहा हूं, गिथब पर कौन सा प्रारूप और संस्करण अपेक्षित है? इसके अलावा, आप टिप्पणी को उत्तर के रूप में पढ़ते हैं, कृपया इसे पूर्ण उत्तर के रूप में पोस्ट करें। फिर से धन्यवाद!

— ब्लंडर्स

+1 @ K3b: आप किसी चीज़ पर विश्वास कर रहे हैं, क्या आप गितुब के गोलम के उपयोग के बारे में बात कर रहे हैं , जो उदाहरण के लिए रिश्तेदार लिंकिंग की अनुमति देता है? यदि हां, तो कृपया इसे उत्तर के रूप में पोस्ट करें, क्योंकि मेरा मानना है कि यह सही उत्तर है। धन्यवाद!

— ब्लंडर

37

मार्कडाउन शब्दार्थ जानकारी प्रदान करने और सादे पाठ में सामान्य प्रारूपण का प्रतिनिधित्व करने के लिए एक सरल वाक्यविन्यास है। डारिंग फायरबॉल में मानक मार्कडाउन के लिए एक भयानक सिंटैक्स गाइड है । GitHub इसके बाद इसके एक प्रकार का उपयोग करता है जिसे वे GitHub Flavoured Markdown कहते हैं ।

अपनी रीडमी को सेट करने के लिए बस एक सादा टेक्स्ट फ़ाइल बनाएं और इसे README (या README.md / README.markdown) नाम दें और इसे अपने रेपो की जड़ में लाएँ। GitHub फिर इस परियोजना को फिर से शुरू करेगा।

— किम बर्गेस
स्रोत

2

मैंने एक वीडियो भी बनाया है जिसमें बताया गया है कि मार्कडाउन का उपयोग कैसे करें। आप इसे यहां पा सकते हैं: mikemclin.net/markdown-syntax-language

— माइक मैकलिन

9

विकिपीडिया - मार्कडाउन " गीथहब फ्लेवर्ड मार्कडाउन - परिचय" ( आर्चव ) पृष्ठ का संदर्भ देता है।

पृष्ठ से उद्धरण:

GitHub संदेशों, मुद्दों और टिप्पणियों के लिए हम "GitHub Flavoured Markdown" (GFM) का उपयोग कर रहे हैं। यह मानक मार्कडाउन (एसएम) से कुछ महत्वपूर्ण तरीकों से अलग है और कुछ अतिरिक्त कार्यक्षमता को जोड़ता है।

पृष्ठ मानक मार्कडाउन के अंतर का विवरण भी देता है।

यह भी अधिक जानकारी है कि मार्कडाउन वास्तव में गिटहब द्वारा कैसे प्रस्तुत किया गया है:

आप कैसे हम Markdown फ़ाइलों प्रस्तुत करना में रुचि रखते हैं, तो आप की जाँच करने के लिए चाहते हो सकता है Redcarpet , के लिए हमारी रूबी इंटरफ़ेस सनडाउन पुस्तकालय।

(स्पष्ट रूप से, सनडाउन वास्तविक मार्कडाउन पार्सर है जिसका उपयोग पर्दे के पीछे किया जाता है।)

अमूर्त की एक और परत जोड़ने के लिए, सनडाउन भी एक और Markdown पार्सर :-) के एक कांटा है
से उद्धरण सनडाउन के GitHub पेज :

सनडाउन एक मार्कडाउन पार्सर है जो नताचा पोर्ते द्वारा अपस्कर्ट लाइब्रेरी के मूल कोड पर आधारित है ।

— क्रिश्चियन स्पीच
स्रोत

1

यह बहुत अजीब है, लेकिन ऐसा लगता है कि जब GADHub एक README फाइल को रेंडर करते समय GitHub-Flavoured Markdown (GFM) का उपयोग नहीं करता है ।

GitHub साइट पर, मुद्दों, टिप्पणियों और पुल अनुरोधों में "GitHub Flavoured Markdown," या GFM का उपयोग करता है।

इसके बजाय यह GitHub मार्कअप परियोजना के हिस्से के रूप में redcarpet नामक एक संस्करण का उपयोग करने के लिए लगता है । वे मीडियाविकी सहित कई अन्य मार्कअप प्रारूपों का भी समर्थन करते हैं। बस सही फ़ाइल एक्सटेंशन का उपयोग करें, और GitHub मार्कअप को प्रस्तुत करेगा।

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

— डॉन कर्कबी
स्रोत

1

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

— 8bittree