2012-04-27 17 views
7

पर मार्कडाउन का उपयोग करने के लिए विस्तृत, विशिष्ट दस्तावेज़ीकरण नहीं मिल सकता है। मैं अपने कुछ रिपो और मेरे उपयोगकर्ता पेज पर जिथब पेज जोड़ने की प्रक्रिया में हूं। कई वेब पेजों के लिए, मैं मार्कडाउन स्वरूपण का उपयोग करना चाहता हूं।github प्रोजेक्ट और उपयोगकर्ता पेज

हालांकि, जैसा कि मुझे यह करने के बारे में जानकारी केवल vague, undetailed जानकारी मिल सकती है, मैं यह पता लगाने के लिए परीक्षण और त्रुटि कर रहा हूं कि यह कैसे काम करता है।

असली दस्तावेज़ीकरण कहां है? गॉरी विवरण?

  • विशेष शाखा का नाम gh-pages का उपयोग एक परियोजना रेपो
  • एक तीन लाइन के लिए एक साइट बनाने के लिए:


    Here सबसे अच्छा जानकारी मैं अब तक मिल गया है, जो कहते हैं है फ़ाइल के शीर्ष पर incantation आवश्यक है:

    --- 
    title: something 
    --- 
    
  • प्रत्ययमें बदल जाता है

लेकिन मैं इस तरह के रूप विवरण के बारे में कई सवाल, साथ छोड़ रहा हूँ:

  • मैं सीएसएस फ़ाइलें आयात कर सकते हैं?
  • वह "शीर्षक" वास्तव में क्या करता है?
  • फ़ाइलों को क्या प्रत्यय की आवश्यकता है?

आदि तो मैं वास्तव में सभी सुविधाओं के लिए विस्तृत दस्तावेज़ीकरण देखना चाहता हूं।


कृपया ध्यान दें कि इस सवाल यह है कि Markdown सिंटैक्स का उपयोग करने के बारे में नहीं है, लेकिन कैसे स्वचालित रूप से उपयोगकर्ता और परियोजना पृष्ठों के दायरे के भीतर Markdown से एचटीएमएल बनाने के लिए GitHub का जादू का दोहन करने के।

उत्तर

4

कैसे स्वचालित रूप से उपयोगकर्ता और परियोजना पृष्ठों के दायरे के भीतर Markdown से एचटीएमएल बनाने

ऐसा लगता है जैसे आप Jekyll के बारे में बात कर रहे हैं के लिए GitHub का जादू का दोहन करने के।


क्या है कि "शीर्षक" blurb वास्तव में क्या करता है?

titleYAML Front Matter का हिस्सा है। यह मूल रूप से एक चर है कि आप कर सकते हैं access के माध्यम से page.title


क्या प्रत्यय फ़ाइलें की जरूरत है?

बशर्ते कि फ़ाइल में वाईएएमएल फ्रंट मैटर सेक्शन है, तो इसे जैकिल द्वारा बदल दिया जाएगा।यह किसी भी .html, .markdown, .md, या .textile फ़ाइल के लिए आपकी साइट की मूल निर्देशिका या निर्देशिका में सूचीबद्ध निर्देशिकाओं के लिए होगा।

github.com/mojombo/jekyll/wiki/usage

0

एक्सटेंशन .md या .markdown साथ केवल फ़ाइलें एक GitHub उपयोगकर्ता पृष्ठ पर HTML करने के लिए अनुवाद किया जाएगा।

एक्सटेंशन .html और .textile साथ

फ़ाइलें मेरी कोशिश करता के अनुसार, नहीं अनुवाद कर रहे हैं।

ध्यान दें कि यूटीएफ 8 एन्कोडिंग से बचा जाना चाहिए।

+0

यूटीएफ 8 से क्यों बचा जाना चाहिए? –

+0

@ मैटफ़ेनविक: यह उल्लेख करता है कि वाईएएमएल फ्रंट मैटर पेज के शीर्ष के पास: https://github.com/mojombo/jekyll/wiki/YAML-Front-Matter। –