2012-03-21 8 views
9

मैं लेख पर पढ़ रहा हूं कि here पर ऐप्पल जैसी HTML दस्तावेज़ कैसे उत्पन्न करें। मेरे प्रश्न हैं कि कमांड लाइनों के लिए क्या उपयोग किया जाता है। हम HTML उत्पन्न करने के लिए कमांड लाइन और सेबडोक xcode प्रोजेक्ट को कैसे जोड़ सकते हैं।ऐप्पल-जैसे दस्तावेज़ों को उत्पन्न करने के लिए एप्लाइडोक का उपयोग कैसे करें

+0

मुझे संदेह है कि ज्यादातर लोग 'एप्लाडोक' प्रोजेक्ट से परिचित हैं, इसलिए आप अपने प्रश्न को थोड़ा और समझाना चाहेंगे। – Caleb

उत्तर

13

मैंने 'appledoc' का उपयोग नहीं किया है, लेकिन आपके द्वारा लिंक किए गए पृष्ठ पर त्वरित रूप से दिखाई देने से ऐसा लगता है कि यह एक ओपन-सोर्स कमांड लाइन उपयोगिता है। तो पहला कदम 'appledoc' प्रोग्राम को संकलित करना होगा, और फिर उसे अपने पथ में मौजूद निर्देशिका में चिपकाएं, जैसे कि /usr/local/bin या ~/bin/

अगला चरण कुछ दस्तावेज उत्पन्न करने के लिए इसका उपयोग करने का प्रयास करना है (यह मानते हुए कि आपने पहले ही मार्कडाउन फाइलें बनाई हैं)। टर्मिनल विंडो खोलने, निर्देशिका जहां अपनी फ़ाइलें हैं पर जाएँ, और उसके बाद कमांड पेज के शीर्ष कि आप लिंक में दिए गए का उपयोग करें:

appledoc --project-name appledoc --project-company "Gentle Bytes" --company-id com.gentlebytes --output ~/help . 

आप अपने दस्तावेज़ को पुनर्जीवित करने के लिए हर 'appledoc' उपयोग करना चाहते हैं जब आप कुछ प्रोजेक्ट बनाते हैं, तो आप अपनी प्रोजेक्ट में किसी मौजूदा लक्ष्य के लिए "रन स्क्रिप्ट" बिल्ड चरण जोड़ सकते हैं, या सिर्फ एक दस्तावेज के लिए एक नया लक्ष्य बना सकते हैं जिसमें "स्क्रिप्ट स्क्रिप्ट" बिल्ड चरण के अलावा कुछ भी नहीं है। किसी भी तरह से, उस चरण में स्क्रिप्ट को शैल स्क्रिप्ट होना चाहिए जिसमें ऊपर दिए गए जैसा ही कमांड होता है (हालांकि आप शायद 'वर्तमान' निर्देशिका का उपयोग करने के बजाय स्पष्ट रूप से स्रोत निर्देशिका निर्दिष्ट करना चाहते हैं, यानी .)।

18

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

  • आप install-appledoc.sh स्क्रिप्ट Git भंडार में शामिल का उपयोग कर सकते हैं: उपयोगकर्ताओं से सभी योगदान -

    भी स्थापित करने के लिए अन्य तरीकों रहे हैं।

  • homebrew नुस्खा भी उपलब्ध है, हालांकि यह मेरी समझ में टेम्पलेट फ़ाइलों को स्थापित नहीं करता है (this link देखें)।

किसी भी अतिरिक्त प्रश्न के लिए appledoc Google group पर जाएं। मैंने इसे कुछ दिन पहले बनाया था, इसलिए इस लेखन के समय कोई सामग्री नहीं है, लेकिन वहां प्रश्न पूछने के लिए स्वतंत्र महसूस करें।

4

जैसा कि मैंने इस post पर पाया, तो आप इस कमांड लाइन के साथ अपने कोड की एक पूरी एचटीएमएल प्रलेखन उत्पन्न कर सकते हैं:

appledoc-परियोजना के नाम BabelCPP-परियोजना के-कंपनी 'माई नेम " - -company-id com.mycompany --no-create-docset --output ./doc/।

अंतिम "।" आपके कोड का मार्ग है।

संबंधित मुद्दे

 संबंधित मुद्दे