GitHub Wiki में ToC या साइडबार

Question

मैं GitHub Wiki में ToC या साइडबार मेनू कैसे बनाऊँ?

मैंने इसके कुछ उल्लेखों को देखा और बैकेंड ने इसका समर्थन करने के लिए कहा, लेकिन मैं इसे वर्तमान गिटबाउ परियोजना में कैसे करूं?

यह मेरे द्वारा पृष्ठ में मेरे द्वारा दिए गए शीर्ष लेखों पर आधारित होना चाहिए।

ये लिंक सभी इसका उल्लेख करते हैं, लेकिन यह नहीं दिखाते हैं कि यह कैसे करना है:

• https://gist.github.com/379469 - कुछ जावास्क्रिप्ट हैक

• https://github.com/blog/774-git-powered-wikis-improved - GitHub इसका उल्लेख कर रहा है:

  "GitHub Wikis के पास फ़ुटर और साइडबार के लिए एक छोटी-सी प्रलेखित क्षमता है, जो कुछ हमारे git- आधारित विकी लेखकों से परिचित हैं। नया विकी संपादक आपको आपके साइट पर आपके द्वारा बनाए गए फ़ुटर्स और साइडबार का सीमित वेब-संपादन देता है। "

Comments

मैंने GitHub Wikifier विकसित किया: एक प्री-कमिट Git Hook जो आपके द्वारा कभी भी आवश्यकता की सभी तालिका बना देगा। बस अपनी सामग्री लिखें, और इसे ले जाने दें। जांच के लायक हो सकता है। github.com/kuroir/GitHub-Wikifier

— मारियोरिकलडे

इसहाक पर: github.com/isaacs/github/issues/504

— Ciro Santilli 病 g g g 法轮功

@MarioRicalde का कोड github.com/hybridgroup/GitHub-Wikifier पर

— जॉनी

Answer 1

जब आपका समाधान काम करता है, तो GitHub के वेब इंटरफ़ेस का उपयोग करने का एक आसान तरीका है। आप बस नाम का एक पेज बना सकते हैं _Sidebarऔर / या _Footer।

मल्टी-लेवल के साथ जीथब विकी साइडबार मेनू बिल्डर में विस्तृत निर्देश देखें ।

संपादित करें मूल लेख चला गया है और मैं इसे कैश में नहीं पा सकता हूं इसलिए मैंने लिंक अपडेट किया है।

Comments

@CodeSherpa वे कम से जाया जा सकता है https://github.com/[user]/[repo]/wiki/_Sidebar/_editऔरhttps://github.com/[user]/[repo]/wiki/_Footer/_edit

— nicerobot

लेख बहुत अच्छा था, लेकिन विकी का URL कैसे प्राप्त करें, इसके बारे में गलत (या पुरानी) जानकारी देता है। यदि आप मेरे खोए हुए हैं, तो आपको URL https://github.com/<username>/<projectname>.wiki.gitया SSH का उपयोग करना होगा [e-mail]:<username>/<projectname>.wiki.git।

— नाइटऑव888

ये विस्तृत निर्देश बहुत खराब हैं। एक क्या है [[link]]? किसी URL को वहाँ रखने से पूरे URL में परिणाम दिखाई देते हैं।

— पिथिकोस

@Pithikos यह Github Markdown बोलते हैं। निर्देश आपको मार्कडाउन सिखाने के लिए नहीं हैं। वे वहाँ साइडबार की व्याख्या करने के लिए हैं।

— nicerobot

@nicerobot और किसी चीज़ को समझाने का सबसे अच्छा तरीका है एक ठोस उदाहरण का उपयोग करके ..

— Pithikos

Answer 2

जब आप अपने प्रोजेक्ट की विकी में होते हैं, तो एक लिंक होता है एक कस्टम साइडबार जोड़ें । उस पर क्लिक करें।

अब आपके पास एक पृष्ठ है जिसे आप संपादित करते हैं जैसा कि आप किसी अन्य मार्कडाउन पृष्ठ को संपादित करेंगे । सामग्री की तालिका बनाने के लिए आपको इसे मैन्युअल रूप से करना होगा। कोई स्वचालित विधि नहीं है (अगस्त 2014 तक)। उदाहरण के लिए:

# My menu
* [Home][home]
* [Technical documentation][techdocs]
* [User manual][usermanual]

[home]: https://github.com/myproject/wiki/Home
[techdocs]: https://github.com/myproject/wiki/Technical-documentation
[usermanual]: https://github.com/myproject/wiki/User-manual

Answer 3

ठीक है। मुझे यह देखने दें कि क्या मैं इसे सही ढंग से समझता हूं:

1. अपने GitHub विकि पर क्लोन करें। (विकी में एक Git सेक्शन है। आप अपने विकी जैसे कोड की जांच कर सकते हैं।)
2. सृजन करना _Sidebar.md
3. सामान्य विकी पृष्ठों में, [[link]]साइडबार के लिए उपयोग करें
4. कमिट करें और वापस GitHub पर धकेलें

यह प्रक्रिया गधे में दर्द है। मुझे आश्चर्य है कि इस "गोलम" विकी की कोई स्वीकृति है।

इसके अलावा: _Sidebar.md इसलिए सभी पृष्ठों के लिए वैश्विक है । मुझे अपने विकी को फ़ोल्डर्स में व्यवस्थित करना होगा, इसलिए मैं अलग-अलग पृष्ठों के लिए अलग-अलग साइडबार को परिभाषित कर सकता हूं।

Comments

डॉक्स के अनुसार, आप विभिन्न फ़ोल्डरों के लिए अलग-अलग साइडबार जोड़ सकते हैं: "साइडबार अपनी निर्देशिका के सभी पृष्ठों और किसी भी उपनिर्देशिका को प्रभावित करते हैं, जिनके पास स्वयं की साइडबार फ़ाइल नहीं होती है।" देखें: github.com/github/gollum

— सबफ्यूज़न

Answer 4

ध्यान दें कि मूल प्रश्न एक साइड बार (आसान, उत्तरों में हल) या सामग्री की वास्तविक तालिका (उत्तर नहीं दिया गया) बनाने के बारे में था।

एक बात मैं कह सकता हूं कि गॉलम 2.1 विकी सिंटैक्स एक [[_TOC_]]टैग के लिए अनुमति देता है , लेकिन गीथहब विकी इसे (अभी तक?) पहचान नहीं करेगा।

Comments

क्या आपको कोई किस्मत मिली है? यह बहुत निराशाजनक रूप से Trac से आया है जहाँ इन सभी चीजों को आसानी से किया गया था।

— jooks

मुझे लगता है कि मूल प्रश्न का एक बेहतर उत्तर यह है कि सामग्री की एक तालिका कैसे बनाई जाए "हेडर मैं स्वचालित रूप से पृष्ठ में है" के आधार पर यह वर्तमान में GitHub Wiki के साथ असंभव है।

— औसतनेट

यह वर्तमान में एक खुला मुद्दा है (संख्या को देखने के लिए बहुत आलसी) जो सैकड़ों लोगों ने टिप्पणी की है। GitHub से अभी तक कोई शब्द वापस नहीं आया :(

— abalter

2017-01-19 के अनुसार इसे संदर्भित करने वाले मुख्य गिटहब मुद्दे हैं: 1. मार्कडाउन - सामग्री की तालिका 2. रेंडर किए गए मार्कडाउन फाइलों पर टीओसी की तरह स्वचालित रूप से जेनरेट की गई तालिका जैसे कि README.md

— ckib16

Answer 5

मुझे लगता है कि यह गोलमREADME में वर्णित है । (हेडर और साइडबार अनुभाग देखें।)

अनिवार्य रूप से, आप पृष्ठ सामग्री वाली निर्देशिका में _footer.extऔर बनाते हैं _sidebar.ext।

Answer 6

मैंने gpmub उपयोगकर्ताओं को आसानी से साइडबार मेनू बनाने और बनाए रखने में मदद करने के लिए npm मॉड्यूल github-wiki-sidebar को लागू किया है ।

स्रोत और परिणाम: https://raw.githubusercontent.com/wiki/adriantanasa/github-wiki-sidebar/images/github-wiki-sidebar-generator.png

स्रोत पृष्ठ (जैसा कि विकी व्यवस्थापक में दिखाया गया है):

Home
Installation
Roadmap
Usage
Usage: Command line modifiers
Usage: Init Mode

परिणाम (अनुकूलित आदेश के साथ):

• घर
• स्थापना
• प्रयोग
  • इनिट मोड
  • कमांड लाइन संशोधक
• रोडमैप

पूर्व आवश्यकताएं:

• स्थानीय रूप से अपने गितुब विकी रिपॉजिटरी को क्लोन करें (विकी यूआई के निचले-दाईं ओर प्रदर्शित)

• गिथब-विकी-साइडबार स्थापित करें

  git clone <https://github.com/<username>/<my-project-name>.wiki.git
  npm install -g github-wiki-sidebar
  

अपना विकी मेनू बनाएं / अपडेट करें:

• अपने github.com wiki व्यवस्थापक पर नए पृष्ठ / नाम बदलें पृष्ठ बनाएं

• अपने विकी रिपॉजिटरी फ़ोल्डर में स्थानीय रूप से जीथब-विकी-साइडबार स्क्रिप्ट निष्पादित करें

  cd /path/to/<my-project-name>.wiki
  # this fetches latest changes, generates sidebar file (_Sidebar.md) and pushes changes to github
  github-wiki-sidebar --git-push
  

मॉड्यूल आइटम, श्रेणी सेपरेटर, मेनू के लिए टेम्पलेट, लिंक के प्रारूप और अन्य के आदेश सहित मार्कडाउन आउटपुट के अनुकूलन की अनुमति देता है।

Answer 7

GitHub सामग्री की एक दस्तावेज़ तालिका स्वतः उत्पन्न करेगा:

1. मार्कडाउन के बजाय डॉक टाइप AsciiDoc बनाएं।
2. :toc:दस्तावेज़ की शुरुआत में डालें ।