2013-08-02 11 views
7

यह थोड़ी देर के लिए मेरे लिए एक रहस्य रहा है, और किसी कारण से Google ने मेरी मदद नहीं की, इसलिए मुझे पूछने दो।गिटहब स्वादित मार्कडाउन (जीएफएम) वास्तव में गिटहब में उपयोग किया जाता है?

संपादित करें: ठीक है, मैं समझता हूं कि जीएफएम गिटहब में हर जगह है, और क्यों जीएफएम स्टाइल लाइन ब्रेक एडिट उपलब्ध नहीं है ?? क्या यह बंद हो गया है? और मैं मूल एमडी नियम जानता हूं। मैं यहां पुष्टि करना चाहता हूं कि जीएफएम लाइन ब्रेक नियम है। धन्यवाद।

मुझे विशेष रूप से सीधे लाइन ब्रेक तरीके के लिए जीएफएम पसंद है। https://help.github.com/articles/github-flavored-markdown हालांकि, मैं इस लाइन बीक मोड के साथ अपना खुद का मार्कडाउन पोस्ट करने में कभी सक्षम नहीं रहा हूं।

उदाहरण के लिए, मैंने कुछ वाक्यविन्यास सूची एमडी को गिटहब पर अपने विकी के एक नए पृष्ठ पर कॉपी किया।

https://github.com/kenokabe/kenokabe.github.io/wiki/MarkDownGFM

आप एमडी स्रोत की पुष्टि कर सकते हैं।

This is intended as a quick reference and showcase. 
For more complete info, see [John Gruber's original spec] 

एक नई लाइन लागू होती है; हालांकि, परिणाम कोई नई लाइन के साथ दिखाया गया है।

मुझे क्या याद आती है? गिटहब स्वादित मार्कडाउन (जीएफएम) वास्तव में गिटहब में उपयोग किया जाता है?

(तकनीकी नोट: Markdown यहाँ GFM पंक्ति विराम का उपयोग करता है, तो एमडी का दो अंतरिक्ष पंक्ति विराम का उपयोग करने की आवश्यकता नहीं है।)

यह निश्चित रूप से तो कहते हैं, लेकिन मैंने पाया इस md 2 रिक्त स्थान br तरीके का उपयोग करता है ।

+0

आप अपनी नई सामग्री को दर्शाने के लिए प्रश्न का शीर्षक बदलना चाहेंगे। –

उत्तर

10

अन्य उत्तर के विपरीत, GFM केवल प्रयोग किया जाता है।

https://help.github.com/articles/github-flavored-markdown से (जोर जोड़ा)

GitHub का उपयोग करता है कि हम क्या संदेशों, मुद्दों, और टिप्पणी के लिए "GitHub फ्लेवर्ड Markdown" (GFM) कॉल कर रहे हैं।

इस के पीछे तर्क है कि README.md और विकी Git संग्रह का हिस्सा हैं, और इसलिए साइट, एक यथोचित जहां उम्मीद होती है (मानक) के बाहर क्लोन किया जा सकता है Markdown बजाय GFM है।

GitHub के औचित्य के बारे में अधिक के लिए, देखें https://github.com/github/markup/issues/208#issuecomment-24927799

संपादित करें:

सिंटेक्स हाइलाइटिंग (Pygments) GFM से अलग है, कि में, GFM वाक्य रचना हाइलाइटिंग कार्यरत हैं, फिर भी वाक्य रचना हाइलाइटिंग की उपस्थिति नहीं है जीएफएम को लागू करें, इसलिए गिटहब पेज मानक मार्कडाउन लाइन-ब्रेक का उपयोग क्यों करेंगे: यह पेंग का उपयोग करता है, लेकिन जीएफएम नहीं।

+0

धन्यवाद। मैंने यही सोचा और पुष्टि करना चाहता था। वास्तव में, मैंने अपने पृष्ठ के लिए आउटपुट के लिए https://github.com/substack/stream-handbook जैसे कुछ पेज बनाने की योजना बनाई थी, लेकिन पाया कि गैर-जीएफएम लाइन ब्रेक के साथ संपादित करना मुश्किल है। मैं अपनी खुद की सामग्री प्रबंधन प्रणाली के विकास के साथ समाप्त होता हूं। –

0

इसका उपयोग तब किया जाता है जब आप अपनी रिपॉजिटरी फ्रंट पेज, for example पर अपनी README.md फ़ाइल प्रदर्शित करते हैं। साथ ही, जब आप टिप्पणी जोड़ते हैं तो यह जीएफएम है।

+1

इसका उपयोग 'गीथब पेज' के लिए भी किया जाता है और इसका अर्थ 'जैकिल' के साथ किया जा सकता है और एचटीएमएल में अनुवाद किया जा सकता है। सीधे एचटीएमएल, आईएमओ लिखने से बेहतर तरीका है। – Houdini

+1

@ हाउडिनी, हाँ, साइट पर लगभग हर जगह, है ना? –

+0

https://github.com/kenokabe/heroku-buildpack-nodejs/blob/master/README.md यह मेरा कुछ README.md है और मैंने शुरुआत में हैलो/एनवर्ल्ड की कोशिश की है। कोई लाइन ब्रेक नहीं, मैं देखता हूं। मुझे क्या याद आती है ?? –

0

GitHub स्वाद markdown पर प्रयोग किया जाता है: अपने रेपो में

  • अपने रेपो के रीडमी फ़ाइल
  • किसी भी .md फ़ाइलों
  • मुद्दों
  • विकिज़ & पृष्ठों

और न्यूनतम पर टिप्पणियां (प्रतिबद्ध, पुल अनुरोध, आदि)

मुद्दों के बारे में एक नोट: ऐसा लगता है जैसे यह विकी पृष्ठों या रीडेमे फ़ाइलों की तुलना में जीएफएम के सीमित संस्करण का उपयोग करता है। जहां पाठ केवल README.md में नहीं और GitHub विकिज़ पर नहीं, GitHub वेबसाइट के माध्यम से प्रवेश किया है

+0

धन्यवाद @xero, क्या आपको कोई विचार है कि जीएफएम विशिष्ट लाइन ब्रेक शैली उन पर क्यों लागू नहीं होती है? –

+1

एनपी। नहीं, मुझे सच में यकीन नहीं है। टिप्पणियों के लिए मुझे लगता है कि यह वही कारणों से है कि वे यहां बहु-पंक्ति टिप्पणियों की अनुमति क्यों नहीं देते हैं। यह उत्तर संदर्भ में ठीक है, लेकिन टिप्पणी संदर्भ नहीं है। – xero