2013-05-14 9 views
37

मैं अपने github Readme.md में किसी समस्या का संदर्भ कैसे दे सकता हूं (एक सापेक्ष लिंक डालें)?गीथब रीडमे - संदर्भ समस्या

मुझे निम्न दस्तावेज़ GitHub Flavored Markdown मिला जहां यह वर्णन किया गया है कि किसी प्रतिबद्धता में किसी समस्या का संदर्भ कैसे दिया जाए, लेकिन रीडमे में नहीं।

उदा। यदि समस्या है: https://github.com/user/project/issues/5 पूर्ण लिंक का उपयोग किए बिना मैं अपने रीडमे में इसे एक लिंक कैसे सेट कर सकता हूं?

उत्तर

17

यह (officially) संभव नहीं है। गिटहब स्वादित मार्कडाउन का उपयोग आपके रेपो में मार्कडाउन फ़ाइलों को प्रस्तुत करने के लिए नहीं किया जाता है, इसका उपयोग केवल मुद्दों और टिप्पणियों के लिए किया जाता है। इसलिए, रीडमे फ़ाइलों को सामान्य मार्कडाउन का उपयोग करके प्रस्तुत किया जाता है, और मुद्दों, एसएचए और इसी तरह की संरचनाओं के लिए कोई ऑटोलिंकिंग नहीं होगी।

+1

हालांकि, आपके पास अभी भी केवल-पढ़ने वाली कार्य सूचियां और सारणी हो सकती हैं। –

37

कि की तरह कुछ कर रही है, तो आप केवल एक ही रेपो, जो 2015/04/29 काम करता है के रूप में से मुद्दों का उल्लेख करना चाहते हैं की एक बहुत बदसूरत तरीका उपलब्ध नहीं है:

see also [#3](/../../issues/3) 
+3

[गिटहब के सापेक्ष लिंक] का अच्छा उपयोग (https://github.com/blog/1395-relative-links-in-markup-files);) – Dennis

+0

भी, यह केवल शाखा नाम _without_ slashes –

+0

के भीतर से ही काम करता है .. .or आवश्यक के रूप में कई अतिरिक्त '../' जोड़ें –

10

इस सख्ती से नहीं है आपके प्रश्न का समाधान, लेकिन शायद आपकी समस्या का समाधान।

मैं भी अपने चेंगेलॉग में लिंक के लिए पूर्ण यूआरएल जोड़ने से बचना चाहता था, क्योंकि यह लाइनों को इतना लंबा और अपठनीय बना देगा।

लेकिन जब संदर्भ शैली लिंक का उपयोग कर, यह बहुत बुरा नहीं है:

* [feature] Add an awesome feature ([#33][i33]) 
* [bug] Finally fixed this stupid bug ([#19][i19]) 

[i19]: https://github.com/user/repo/issues/19 
[i33]: https://github.com/user/repo/issues/33 

बड़ा लाभ यह है कि यह भी Github के बाहर काम करता है।