README फ़ाइलों को अपडेट करते समय मैं github द्वारा उपयोग की जाने वाली हल्के मार्कअप भाषा से बहुत परिचित नहीं हूं।
मेरे ओपन सोर्स लाइब्रेरी की README / विकी फाइलों के लिए उपयुक्त मार्कअप सिंटैक्स लिखने के तरीके पर मैं कहां से पढ़ सकता हूं?
और क्या कोई उपकरण है जो मैं अपडेट किए गए README को अपने गितुब रिपॉजिटरी में धकेलने से पहले "अपने डॉक्स को अपने ब्राउज़र में स्थानीय रूप से समीक्षा कर सकता हूं"?
जवाबों:
प्रश्न में मार्कअप संयोग से मार्कडाउन कहलाता है , जिसे डारिंग फायरबॉल ब्लॉग के लेखक जॉन ग्रुबर ने बनाया है । मार्कडाउन का मूल स्रोत डारिंग फायरबॉल - मार्कडाउन में पाया जा सकता है ।
कई मार्कडाउन बोलियाँ हैं, जीथब के लिए प्रलेखन जीथब फ्लेवर्डड मार्कडाउन पृष्ठ पर पाया जा सकता है ।
उस पेज से अच्छा टिप:
किसी भी Github पेज पर M को एक मार्कटड एडिटर के साथ दबाएं ताकि वह चीटशीट प्रकट कर सके।
आप अपने मार्कडाउन दस्तावेजों का परीक्षण करने के लिए जीथूब मार्कडाउन लाइव पूर्वावलोकन पृष्ठ का उपयोग कर सकते हैं ।
अद्यतन 2012-11-08 : मार्कडाउन सिंटैक्स को मानकीकृत करने के प्रयास चल रहे हैं। मार्कडाउन का भविष्य देखें - जेफ एटवुड, कोडिंग हॉरर और डब्ल्यू 3 सी मार्कडाउन कम्युनिटी ग्रुप ।
अद्यतन 2014-09-09 : कॉमनमार्क एक मार्कडाउन मानक और कल्पना जारी की गई है।
( कुछ संपादनों के साथ इस उत्तर को पुनः पोस्ट करना ।)
खेल में थोड़ा देर हो गई, लेकिन मैंने पायथन में एक छोटा सीएलआई लिखा। इसे ग्रिप (Github Readme Instant Preview) कहा जाता है । पैट्रिक के जवाब में जोड़ते हुए, यह आपको "मेरे ब्राउज़र में स्थानीय रूप से मेरे डॉक्स की समीक्षा करने देगा।"
इसे स्थापित करें:
$ pip install grip
और इसका उपयोग करने के लिए, बस:
$ grip
फिर उस स्थान पर फ़ाइल localhost:5000देखने के लिए जाएं readme.md।
आप अपनी खुद की फ़ाइल भी निर्दिष्ट कर सकते हैं:
$ grip CHANGES.md
और पोर्ट बदलें:
$ grip 8080
या पिछले दो को मिलाएं:
$ grip CHANGES.md 8080
आप GitHub-Flavoured Markdown को भी रेंडर कर सकते हैं (यानी कैसे टिप्पणियाँ और मुद्दों का प्रतिपादन किया जाता है), वैकल्पिक रूप से रेपो संदर्भ के साथ ऑटो-हाइपरलिंक अन्य मुद्दों के संदर्भ में:
$ grip --gfm --context=username/repo issue.md
संक्षिप्तता के लिए, CLI सहायता का उपयोग करते हुए बाकी विकल्प और उनके विवरण देखें:
$ grip -h
उल्लेखनीय विशेषताएं:
उम्मीद है की यह मदद करेगा। इसे देखें ।
यहाँ एक अच्छा ऑनलाइन / लाइव संपादक है:
http://jbt.github.io/markdown-editor/
PreviewGitHub पर एक बटन भी है।
निम्न स्क्रीनशॉट में देखें कि यह बटन तब दिखाई देता है जब मैंने संपादन पर क्लिक किया था README.md।
IMHO लाइव संपादक GitHub पर उपलब्ध वर्तमान एक से बेहतर है।
अपडेट करें
अभी-अभी मैंने Markdownविज़ुअल स्टूडियो की खोज करने के बाद पाया कि यदि आप वीएस का उपयोग कर रहे हैं, तो आप वेब एसेंशियल इंस्टॉल कर सकते हैं और Markdownविजुअल स्टूडियो के भीतर से ही सही समर्थन कर सकते हैं । यह अच्छा है!
यह है:
इसके बारे में यहाँ विवरण ।
ध्यान दें कि फरवरी 2014 के बाद से, " रेंडरेड प्रोस डिफ्स " के साथ, आप एक मार्कडाउन फाइल पर एक फॉर्म का गाया हुआ संस्करण भी देख सकते हैं:
गद्य फ़ाइलों सहित अनुरोध और पुल अब स्रोत और प्रदान किए गए विचारों को शामिल करते हैं ।
गैर-पाठ परिवर्तन कम-कुंजी बिंदीदार रेखांकन के साथ दिखाई देते हैं। जो बदल गया है उसे देखने के लिए पाठ पर होवर करें:
एक अन्य विकल्प - जीथब के नए टेक्स्ट एडिटर, एटम, एडिट करते हुए जीथब-फ्लेवर्ड मार्कडाउन प्रस्तुत करेंगे। देखHttps://atom.io/
मुझे यकीन नहीं है कि लंबी अवधि में यह (बीयर के रूप में) मुफ्त होगा।
मुझे नहीं लगा कि अन्य उपकरण काफी अच्छे थे - मैं चाहता था:
यह वही है जो मैंने अंततः तय किया: https://github.com/ypocat/gfms
> gfms
Github Flavored Markdown Server.
Run in your project's root directory.
Usage: gfms
Options:
-p, --port Port number to listen at. [required]
-h, --host Host address to bind to. [default: "localhost"]
--proxy if behind a proxy, proxy url.
-a, --api Render using Github API.
-n, --no-api-on-reload Disable usage of Github API when the doc is manually reloaded.
इसलिए मैं अलियास हो गया हूं:
alias gm='gfms -a -p 8070'
-pविकल्प का उपयोग करने से जीथब एपीआई हिट हो जाता है और वास्तविक, वर्तमान जीथब सीएसएस का उपयोग होता है ताकि कोई आश्चर्य न हो।